java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacatalog.model.Attribute

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Attribute
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Details of an entity attribute.
An attribute of a data entity describing an item of data, with a name and data type. Synonymous with ‘column’ in a database.
Note: Objects should always be created or deserialized using the Attribute.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 Attribute.Builder, which maintain a set of all explicitly set fields called Attribute.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).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Attribute.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
Attribute(String key, String displayName, String businessName, String description, String entityKey, LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String externalDataType, String externalKey, Boolean isIncrementalData, Boolean isNullable, String typeKey, Integer minCollectionCount, Integer maxCollectionCount, String datatypeEntityKey, String externalDatatypeEntityKey, String parentAttributeKey, String externalParentAttributeKey, Long length, Integer position, Integer precision, Integer scale, Date timeExternal, Date timeHarvested, List<ObjectRelationship> objectRelationships, Boolean isDerivedAttribute, String uri, String path, List<CustomPropertyGetUsage> customPropertyMembers, Map<String,Map<String,String>> properties, List<RuleType> associatedRuleTypes)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Attribute.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`List<RuleType>`	`getAssociatedRuleTypes()`	Rule types associated with attribute.
`String`	`getBusinessName()`	Optional user friendly business name of the attribute.
`String`	`getCreatedById()`	OCID of the user who created this attribute in the data catalog.
`List<CustomPropertyGetUsage>`	`getCustomPropertyMembers()`	The list of customized properties along with the values for this object
`String`	`getDatatypeEntityKey()`	Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
`String`	`getDescription()`	Detailed description of the attribute.
`String`	`getDisplayName()`	A user-friendly display name.
`String`	`getEntityKey()`	The unique key of the parent entity.
`String`	`getExternalDataType()`	Data type of the attribute as defined in the external system.
`String`	`getExternalDatatypeEntityKey()`	External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
`String`	`getExternalKey()`	Unique external key of this attribute in the external source system.
`String`	`getExternalParentAttributeKey()`	External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
`Boolean`	`getIsDerivedAttribute()`	Whether a column is derived or not.
`Boolean`	`getIsIncrementalData()`	Property that identifies if this attribute can be used as a watermark to extract incremental data.
`Boolean`	`getIsNullable()`	Property that identifies if this attribute can be assigned null values.
`String`	`getKey()`	Unique attribute key that is immutable.
`Long`	`getLength()`	Max allowed length of the attribute value.
`String`	`getLifecycleDetails()`	A message describing the current state in more detail.
`LifecycleState`	`getLifecycleState()`	State of the attribute.
`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.
`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.
`List<ObjectRelationship>`	`getObjectRelationships()`	List of objects and their relationships to this attribute.
`String`	`getParentAttributeKey()`	Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
`String`	`getPath()`	Full path of the attribute.
`Integer`	`getPosition()`	Position of the attribute in the record definition.
`Integer`	`getPrecision()`	Precision of the attribute value usually applies to float data type.
`Map<String,Map<String,String>>`	`getProperties()`	A map of maps that contains the properties which are specific to the attribute type.
`Integer`	`getScale()`	Scale of the attribute value usually applies to float data type.
`Date`	`getTimeCreated()`	The date and time the attribute was created, in the format defined by RFC3339.
`Date`	`getTimeExternal()`	Last modified timestamp of this object in the external system.
`Date`	`getTimeHarvested()`	The date and time the attribute was harvested, in the format defined by RFC3339.
`Date`	`getTimeUpdated()`	The last time that any change was made to the attribute.
`String`	`getTypeKey()`	The type of the attribute.
`String`	`getUpdatedById()`	OCID of the user who modified this attribute in the data catalog.
`String`	`getUri()`	URI to the attribute instance in the API.
`int`	`hashCode()`
`Attribute.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Attribute
```
@Deprecated
@ConstructorProperties({"key","displayName","businessName","description","entityKey","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","createdById","updatedById","externalDataType","externalKey","isIncrementalData","isNullable","typeKey","minCollectionCount","maxCollectionCount","datatypeEntityKey","externalDatatypeEntityKey","parentAttributeKey","externalParentAttributeKey","length","position","precision","scale","timeExternal","timeHarvested","objectRelationships","isDerivedAttribute","uri","path","customPropertyMembers","properties","associatedRuleTypes"})
public Attribute(String key,
                 String displayName,
                 String businessName,
                 String description,
                 String entityKey,
                 LifecycleState lifecycleState,
                 String lifecycleDetails,
                 Date timeCreated,
                 Date timeUpdated,
                 String createdById,
                 String updatedById,
                 String externalDataType,
                 String externalKey,
                 Boolean isIncrementalData,
                 Boolean isNullable,
                 String typeKey,
                 Integer minCollectionCount,
                 Integer maxCollectionCount,
                 String datatypeEntityKey,
                 String externalDatatypeEntityKey,
                 String parentAttributeKey,
                 String externalParentAttributeKey,
                 Long length,
                 Integer position,
                 Integer precision,
                 Integer scale,
                 Date timeExternal,
                 Date timeHarvested,
                 List<ObjectRelationship> objectRelationships,
                 Boolean isDerivedAttribute,
                 String uri,
                 String path,
                 List<CustomPropertyGetUsage> customPropertyMembers,
                 Map<String,Map<String,String>> properties,
                 List<RuleType> associatedRuleTypes)
```
    Deprecated.
- Method Detail
  - builder
```
public static Attribute.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public Attribute.Builder toBuilder()
```
  - getKey
```
public String getKey()
```
    Unique attribute key that is immutable.
    
    Returns:
    
    the value
  - 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
  - getEntityKey
```
public String getEntityKey()
```
    The unique key of the parent entity.
    
    Returns:
    
    the value
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    State of the attribute.
    
    Returns:
    
    the value
  - getLifecycleDetails
```
public String getLifecycleDetails()
```
    A message describing the current state in more detail.
    An object not in ACTIVE state may have functional limitations, see service documentation for details.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The date and time the attribute 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 attribute.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getCreatedById
```
public String getCreatedById()
```
    OCID of the user who created this attribute in the data catalog.
    
    Returns:
    
    the value
  - getUpdatedById
```
public String getUpdatedById()
```
    OCID of the user who modified this attribute in the data catalog.
    
    Returns:
    
    the value
  - getExternalDataType
```
public String getExternalDataType()
```
    Data type of the attribute as defined in the external system.
    Type mapping across systems can be achieved through term associations across domains in the ontology. The attribute can also be tagged to the datatype in the domain ontology to resolve any ambiguity arising from type name similarity that can occur with user defined types.
    
    Returns:
    
    the value
  - getExternalKey
```
public String getExternalKey()
```
    Unique external key of this attribute in the external source 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
  - getTypeKey
```
public String getTypeKey()
```
    The type of the attribute.
    Type keys can be found via the ‘/types’ endpoint.
    
    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
  - getDatatypeEntityKey
```
public String getDatatypeEntityKey()
```
    Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
    
    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
  - getParentAttributeKey
```
public String getParentAttributeKey()
```
    Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
    
    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
  - 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
  - getTimeHarvested
```
public Date getTimeHarvested()
```
    The date and time the attribute was harvested, in the format defined by RFC3339.
    
    Returns:
    
    the value
  - getObjectRelationships
```
public List<ObjectRelationship> getObjectRelationships()
```
    List of objects and their relationships to this attribute.
    
    Returns:
    
    the value
  - getIsDerivedAttribute
```
public Boolean getIsDerivedAttribute()
```
    Whether a column is derived or not.
    
    Returns:
    
    the value
  - getUri
```
public String getUri()
```
    URI to the attribute instance in the API.
    
    Returns:
    
    the value
  - getPath
```
public String getPath()
```
    Full path of the attribute.
    
    Returns:
    
    the value
  - getCustomPropertyMembers
```
public List<CustomPropertyGetUsage> getCustomPropertyMembers()
```
    The list of customized properties along with the values for this object
    
    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. Example: {“properties”: { “default”: { “key1”: “value1”}}}
    
    Returns:
    
    the value
  - getAssociatedRuleTypes
```
public List<RuleType> getAssociatedRuleTypes()
```
    Rule types associated with attribute.
    
    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

Class Attribute

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Attribute

Method Detail

builder

toBuilder

getKey

getDisplayName

getBusinessName

getDescription

getEntityKey

getLifecycleState

getLifecycleDetails

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getExternalDataType

getExternalKey

getIsIncrementalData

getIsNullable

getTypeKey

getMinCollectionCount

getMaxCollectionCount

getDatatypeEntityKey

getExternalDatatypeEntityKey

getParentAttributeKey

getExternalParentAttributeKey

getLength

getPosition

getPrecision

getScale

getTimeExternal

getTimeHarvested

getObjectRelationships

getIsDerivedAttribute

getUri

getPath

getCustomPropertyMembers

getProperties

getAssociatedRuleTypes

toString

toString

equals

hashCode