@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class AttributeSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 AttributeSummary.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
AttributeSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
AttributeSummary(String key,
String displayName,
String businessName,
String description,
String entityKey,
String externalKey,
Long length,
Integer position,
Integer precision,
Integer scale,
Boolean isNullable,
String uri,
LifecycleState lifecycleState,
String lifecycleDetails,
Date timeCreated,
String externalDataType,
String typeKey,
Integer minCollectionCount,
Integer maxCollectionCount,
String datatypeEntityKey,
String externalDatatypeEntityKey,
String parentAttributeKey,
String externalParentAttributeKey,
String path,
List<CustomPropertyGetUsage> customPropertyMembers,
List<RuleType> associatedRuleTypes,
Boolean isDerivedAttribute,
Date timeUpdated,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AttributeSummary.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.
|
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 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 |
getIsDerivedAttribute()
Whether a column is derived or not.
|
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.
|
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 |
getTimeUpdated()
The last time that any change was made to the attribute.
|
String |
getTypeKey()
The type of the attribute.
|
String |
getUri()
URI to the attribute instance in the API.
|
int |
hashCode() |
AttributeSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","displayName","businessName","description","entityKey","externalKey","length","position","precision","scale","isNullable","uri","lifecycleState","lifecycleDetails","timeCreated","externalDataType","typeKey","minCollectionCount","maxCollectionCount","datatypeEntityKey","externalDatatypeEntityKey","parentAttributeKey","externalParentAttributeKey","path","customPropertyMembers","associatedRuleTypes","isDerivedAttribute","timeUpdated","properties"}) public AttributeSummary(String key, String displayName, String businessName, String description, String entityKey, String externalKey, Long length, Integer position, Integer precision, Integer scale, Boolean isNullable, String uri, LifecycleState lifecycleState, String lifecycleDetails, Date timeCreated, String externalDataType, String typeKey, Integer minCollectionCount, Integer maxCollectionCount, String datatypeEntityKey, String externalDatatypeEntityKey, String parentAttributeKey, String externalParentAttributeKey, String path, List<CustomPropertyGetUsage> customPropertyMembers, List<RuleType> associatedRuleTypes, Boolean isDerivedAttribute, Date timeUpdated, Map<String,Map<String,String>> properties)
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 getBusinessName()
Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.
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 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 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 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.
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 String getTypeKey()
The type of the attribute. Type keys can be found via the ‘/types’ endpoint.
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<CustomPropertyGetUsage> getCustomPropertyMembers()
The list of customized properties along with the values for this object
public List<RuleType> getAssociatedRuleTypes()
Rule types associated with attribute.
public Boolean getIsDerivedAttribute()
Whether a column is derived or not.
public Date getTimeUpdated()
The last time that any change was made to the attribute. An RFC3339 formatted datetime string.
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 String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.