Package com.oracle.bmc.datacatalog.model

Class CreateCustomPropertyDetails

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

      • getDescription

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

      • getDataType

        public CustomPropertyDataType getDataType()
        The data type of the custom property
        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

      • getIsHiddenInSearch

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

      • getIsEventEnabled

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

      • getAllowedValues

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

      • getProperties

        public Map<String,​Map<String,​String>> getProperties()
        A map of maps that contains the properties which are specific to the data 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. To determine the set of optional and required properties for a data asset type, a query can be done on ‘/types?type=dataAsset’ that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it’s properties, can be identified from this collection. 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