Package com.oracle.bmc.datacatalog.model

Class CustomProperty

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class CustomProperty
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Custom Property Definition
    Note: Objects should always be created or deserialized using the CustomProperty.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 CustomProperty.Builder, which maintain a set of all explicitly set fields called CustomProperty.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 data asset key that is immutable.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Display name of the custom property
        Returns:
        the value

      • getDataType

        public CustomPropertyDataType getDataType()
        Data type of the custom property
        Returns:
        the value

      • getDescription

        public String getDescription()
        Description for the custom property
        Returns:
        the value

      • getNamespaceName

        public String getNamespaceName()
        Namespace name of the custom property
        Returns:
        the value

      • getIsListType

        public Boolean getIsListType()
        Is this property allowed to have list of values
        Returns:
        the value

      • getIsSortable

        public Boolean getIsSortable()
        If this field allows to sort from UI
        Returns:
        the value

      • getIsFilterable

        public Boolean getIsFilterable()
        If this field allows to filter or create facets from UI
        Returns:
        the value

      • getIsMultiValued

        public Boolean getIsMultiValued()
        If this field allows multiple values to be set
        Returns:
        the value

      • getIsHidden

        public Boolean getIsHidden()
        If this field is a hidden field
        Returns:
        the value

      • getIsEditable

        public Boolean getIsEditable()
        If this field is a editable field
        Returns:
        the value

      • getIsShownInList

        public Boolean getIsShownInList()
        If this field is displayed in a list view of applicable objects.
        Returns:
        the value

      • getIsServiceDefined

        public Boolean getIsServiceDefined()
        If this field is defined by service or by a user
        Returns:
        the value

      • getIsHiddenInSearch

        public Boolean getIsHiddenInSearch()
        If this field is allowed to pop in search results
        Returns:
        the value

      • getLifecycleState

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

      • getTimeCreated

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

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getCreatedById

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

      • getUpdatedById

        public String getUpdatedById()
        OCID of the user who last modified the custom property.
        Returns:
        the value

      • getUsageCount

        public Integer getUsageCount()
        Total number of first class objects using this custom property
        Returns:
        the value

      • getIsEventEnabled

        public Boolean getIsEventEnabled()
        If an OCI Event will be emitted when the custom property is modified.
        Returns:
        the value

      • getScope

        public List<CustomPropertyTypeUsage> getScope()
        The set of object types to which the custom property applies.
        Returns:
        the value

      • getAllowedValues

        public List<String> getAllowedValues()
        Allowed values for the custom property if any
        Returns:
        the value

      • getEvents

        public List<EventConfig> getEvents()
        Event configuration for this custom property, against the desired subset of object types to which the property applies.
        Returns:
        the value

      • getProperties

        public Map<String,​Map<String,​String>> getProperties()
        A map of maps that contains the properties which are specific to the asset type.

        Each data asset 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 data assets have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

        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