@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class Attribute extends Object
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.
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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
Attribute.Builder |
| Constructor and Description |
|---|
Attribute(String key,
String displayName,
String description,
String entityKey,
LifecycleState lifecycleState,
Date timeCreated,
Date timeUpdated,
String createdById,
String updatedById,
String externalDataType,
String externalKey,
Boolean isIncrementalData,
Boolean isNullable,
Integer minCollectionCount,
Integer maxCollectionCount,
String datatypeEntityKey,
String externalDatatypeEntityKey,
String parentAttributeKey,
String externalParentAttributeKey,
Long length,
Integer position,
Integer precision,
Integer scale,
Date timeExternal,
String uri,
String path,
List<CustomPropertyGetUsage> customPropertyMembers,
Map<String,Map<String,String>> properties,
List<RuleType> associatedRuleTypes)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Attribute.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
List<RuleType> |
getAssociatedRuleTypes()
Rule types associated with 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 |
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.
|
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.
|
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 |
getTimeUpdated()
The last time that any change was made to 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() |
@ConstructorProperties(value={"key","displayName","description","entityKey","lifecycleState","timeCreated","timeUpdated","createdById","updatedById","externalDataType","externalKey","isIncrementalData","isNullable","minCollectionCount","maxCollectionCount","datatypeEntityKey","externalDatatypeEntityKey","parentAttributeKey","externalParentAttributeKey","length","position","precision","scale","timeExternal","uri","path","customPropertyMembers","properties","associatedRuleTypes"}) @Deprecated public Attribute(String key, String displayName, String description, String entityKey, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String externalDataType, String externalKey, Boolean isIncrementalData, Boolean isNullable, Integer minCollectionCount, Integer maxCollectionCount, String datatypeEntityKey, String externalDatatypeEntityKey, String parentAttributeKey, String externalParentAttributeKey, Long length, Integer position, Integer precision, Integer scale, Date timeExternal, String uri, String path, List<CustomPropertyGetUsage> customPropertyMembers, Map<String,Map<String,String>> properties, List<RuleType> associatedRuleTypes)
public static Attribute.Builder builder()
Create a new builder.
public Attribute.Builder toBuilder()
public String getKey()
Unique attribute key that is immutable.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getDescription()
Detailed description of the attribute.
public String getEntityKey()
The unique key of the parent entity.
public LifecycleState getLifecycleState()
State of the attribute.
public Date getTimeCreated()
The date and time the attribute was created, in the format defined by RFC3339.
Example: 2019-03-25T21:10:29.600Z
public Date getTimeUpdated()
The last time that any change was made to the attribute. An RFC3339 formatted datetime string.
public String getCreatedById()
OCID of the user who created this attribute in the data catalog.
public String getUpdatedById()
OCID of the user who modified this attribute in the data catalog.
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.
public String getExternalKey()
Unique external key of this attribute in the external source system.
public Boolean getIsIncrementalData()
Property that identifies if this attribute can be used as a watermark to extract incremental data.
public Boolean getIsNullable()
Property that identifies if this attribute can be assigned null values.
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.
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
public String getDatatypeEntityKey()
Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
public String getExternalDatatypeEntityKey()
External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
public String getParentAttributeKey()
Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.
public String getExternalParentAttributeKey()
External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
public Long getLength()
Max allowed length of the attribute value.
public Integer getPosition()
Position of the attribute in the record definition.
public Integer getPrecision()
Precision of the attribute value usually applies to float data type.
public Integer getScale()
Scale of the attribute value usually applies to float data type.
public Date getTimeExternal()
Last modified timestamp of this object in the external system.
public String getUri()
URI to the attribute instance in the API.
public String getPath()
Full path of the attribute.
public List<CustomPropertyGetUsage> getCustomPropertyMembers()
The list of customized properties along with the values for this object
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\"}}}
public List<RuleType> getAssociatedRuleTypes()
Rule types associated with attribute.
Copyright © 2016–2021. All rights reserved.