Package com.oracle.bmc.datacatalog.model

Class CreateAttributeDetails

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

      • getBusinessName

        public String getBusinessName()
        Optional user friendly business name of the attribute.

        If set, this supplements the harvested display name of the object.

        Returns:
        the value

      • getDescription

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

      • getExternalDataType

        public String getExternalDataType()
        Data type of the attribute as defined in the external system.
        Returns:
        the value

      • getIsIncrementalData

        public Boolean getIsIncrementalData()
        Property that identifies if this attribute can be used as a watermark to extract incremental data.
        Returns:
        the value

      • getIsNullable

        public Boolean getIsNullable()
        Property that identifies if this attribute can be assigned null values.
        Returns:
        the value

      • getLength

        public Long getLength()
        Max allowed length of the attribute value.
        Returns:
        the value

      • getPosition

        public Integer getPosition()
        Position of the attribute in the record definition.
        Returns:
        the value

      • getPrecision

        public Integer getPrecision()
        Precision of the attribute value usually applies to float data type.
        Returns:
        the value

      • getScale

        public Integer getScale()
        Scale of the attribute value usually applies to float data type.
        Returns:
        the value

      • getTimeExternal

        public Date getTimeExternal()
        Last modified timestamp of this object in the external system.
        Returns:
        the value

      • getMinCollectionCount

        public Integer getMinCollectionCount()
        The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
        Returns:
        the value

      • getMaxCollectionCount

        public Integer getMaxCollectionCount()
        The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

        For type specifications in systems that specify only “capacity” without upper or lower bound , this property can also be used to just mean “capacity”. Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json

        Returns:
        the value

      • getExternalDatatypeEntityKey

        public String getExternalDatatypeEntityKey()
        External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
        Returns:
        the value

      • getExternalParentAttributeKey

        public String getExternalParentAttributeKey()
        External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
        Returns:
        the value

      • getCustomPropertyMembers

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

      • getTypeKey

        public String getTypeKey()
        Type key of the object.

        Type keys can be found via the ‘/types’ endpoint.

        Returns:
        the value

      • getProperties

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

        Each attribute 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 attributes have required properties within the “default” category. To determine the set of required and optional properties for an attribute type, a query can be done on ‘/types?type=attribute’ that returns a collection of all attribute types. The appropriate attribute type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “key1”: “value1”}}}

        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