@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class AttributeSummary extends Object
Summary of an entity attribute.
Note: Objects should always be created or deserialized using the AttributeSummary.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 AttributeSummary.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 |
AttributeSummary.Builder |
Constructor and Description |
---|
AttributeSummary(String key,
String displayName,
String description,
String entityKey,
String externalKey,
Long length,
Integer precision,
Integer scale,
Boolean isNullable,
String uri,
LifecycleState lifecycleState,
Date timeCreated,
String externalDataType,
Integer minCollectionCount,
Integer maxCollectionCount,
String datatypeEntityKey,
String externalDatatypeEntityKey,
String parentAttributeKey,
String externalParentAttributeKey,
String path,
List<RuleType> associatedRuleTypes)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AttributeSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
List<RuleType> |
getAssociatedRuleTypes()
Rule types associated with attribute.
|
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 source 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 |
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 |
getPrecision()
Precision of the attribute value usually applies to float data 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.
|
String |
getUri()
URI to the attribute instance in the API.
|
int |
hashCode() |
AttributeSummary.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"key","displayName","description","entityKey","externalKey","length","precision","scale","isNullable","uri","lifecycleState","timeCreated","externalDataType","minCollectionCount","maxCollectionCount","datatypeEntityKey","externalDatatypeEntityKey","parentAttributeKey","externalParentAttributeKey","path","associatedRuleTypes"}) @Deprecated public AttributeSummary(String key, String displayName, String description, String entityKey, String externalKey, Long length, Integer precision, Integer scale, Boolean isNullable, String uri, LifecycleState lifecycleState, Date timeCreated, String externalDataType, Integer minCollectionCount, Integer maxCollectionCount, String datatypeEntityKey, String externalDatatypeEntityKey, String parentAttributeKey, String externalParentAttributeKey, String path, List<RuleType> associatedRuleTypes)
public static AttributeSummary.Builder builder()
Create a new builder.
public AttributeSummary.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 String getExternalKey()
Unique external key of this attribute in the external source system.
public Long getLength()
Max allowed length of the attribute value.
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 Boolean getIsNullable()
Property that identifies if this attribute can be assigned null values.
public String getUri()
URI to the attribute instance in the API.
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 String getExternalDataType()
Data type of the attribute as defined in the external source system.
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 String getPath()
Full path of the attribute.
public List<RuleType> getAssociatedRuleTypes()
Rule types associated with attribute.
Copyright © 2016–2021. All rights reserved.