EntityAttribute (IBM Information Governance Catalog REST API Client Library 1.0 API)

java.lang.Object
- org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
- - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
  - - org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.generated.v11501.EntityAttribute

```
public class EntityAttribute
extends Reference
```
POJO for the entity_attribute asset type in IGC, displayed as 'Entity Attribute' in the IGC UI.

(this code has been generated based on out-of-the-box IGC metadata types; if modifications are needed, eg. to handle custom attributes, extending from this class in your own custom class is the best approach.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' in the IGC UI.
`protected ReferenceList`	`child_logical_foreign_keys` The `child_logical_foreign_keys` property, displayed as 'Child Logical Foreign Keys' in the IGC UI.
`protected String`	`created_by` The `created_by` property, displayed as 'Created By' in the IGC UI.
`protected Date`	`created_on` The `created_on` property, displayed as 'Created On' in the IGC UI.
`protected String`	`data_type` The `data_type` property, displayed as 'Data Type' in the IGC UI.
`protected ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected ReferenceList`	`implemented_by_database_columns` The `implemented_by_database_columns` property, displayed as 'Implemented by Database Columns' in the IGC UI.
`protected ReferenceList`	`implemented_by_design_columns` The `implemented_by_design_columns` property, displayed as 'Implemented by Design Columns' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected ReferenceList`	`in_collections` The `in_collections` property, displayed as 'In Collections' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Number`	`length` The `length` property, displayed as 'Length' in the IGC UI.
`protected Reference`	`logical_entity` The `logical_entity` property, displayed as 'Logical Entity' in the IGC UI.
`protected ReferenceList`	`logical_keys` The `logical_keys` property, displayed as 'Logical Keys' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected String`	`modified_by` The `modified_by` property, displayed as 'Modified By' in the IGC UI.
`protected Date`	`modified_on` The `modified_on` property, displayed as 'Modified On' in the IGC UI.
`protected String`	`name` The `name` property, displayed as 'Name' in the IGC UI.
`protected String`	`native_type` The `native_type` property, displayed as 'Native Type' in the IGC UI.
`protected ReferenceList`	`parent_logical_foreignKey` The `parent_logical_foreignKey` property, displayed as 'Parent Logical Foreign Key' in the IGC UI.
`protected String`	`physical_name` The `physical_name` property, displayed as 'Physical Name' in the IGC UI.
`protected Boolean`	`primary_key` The `primary_key` property, displayed as 'Primary Key' in the IGC UI.
`protected Boolean`	`required` The `required` property, displayed as 'Required' in the IGC UI.
`protected Number`	`scale` The `scale` property, displayed as 'Scale' in the IGC UI.
`protected Number`	`sequence` The `sequence` property, displayed as 'Sequence' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected Reference`	`validation_list` The `validation_list` property, displayed as 'Validation List' in the IGC UI.
`protected Reference`	`validation_range` The `validation_range` property, displayed as 'Validation Range' in the IGC UI.
`protected Reference`	`validation_rule` The `validation_rule` property, displayed as 'Validation Rule' in the IGC UI.

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
_context, _id, _name, _type, _url

Constructor Summary

Constructors
Constructor and Description

EntityAttribute()

Constructors
Constructor and Description
`EntityAttribute()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAssignedToTerms()`
`ReferenceList`	`getChildLogicalForeignKeys()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDataType()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementedByDatabaseColumns()`
`ReferenceList`	`getImplementedByDesignColumns()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`Number`	`getLength()`
`Reference`	`getLogicalEntity()`
`ReferenceList`	`getLogicalKeys()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`String`	`getNativeType()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`ReferenceList`	`getParentLogicalForeignkey()`
`String`	`getPhysicalName()`
`Boolean`	`getPrimaryKey()`
`Boolean`	`getRequired()`
`Number`	`getScale()`
`Number`	`getSequence()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`Reference`	`getValidationList()`
`Reference`	`getValidationRange()`
`Reference`	`getValidationRule()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isEntityAttribute(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setChildLogicalForeignKeys(ReferenceList child_logical_foreign_keys)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataType(String data_type)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementedByDatabaseColumns(ReferenceList implemented_by_database_columns)`
`void`	`setImplementedByDesignColumns(ReferenceList implemented_by_design_columns)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLength(Number length)`
`void`	`setLogicalEntity(Reference logical_entity)`
`void`	`setLogicalKeys(ReferenceList logical_keys)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setNativeType(String native_type)`
`void`	`setParentLogicalForeignkey(ReferenceList parent_logical_foreignKey)`
`void`	`setPhysicalName(String physical_name)`
`void`	`setPrimaryKey(Boolean primary_key)`
`void`	`setRequired(Boolean required)`
`void`	`setScale(Number scale)`
`void`	`setSequence(Number sequence)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setValidationList(Reference validation_list)`
`void`	`setValidationRange(Reference validation_range)`
`void`	`setValidationRule(Reference validation_rule)`

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference
canAssetBeCreatedFromPOJO, getAllPropertiesFromPOJO, getAssetDetails, getAssetTypeForSearch, getAssetTypeFromPOJO, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getAssetWithSubsetOfProperties, getContext, getDisplayNameFromPOJO, getFieldByName, getFullAssetDetails, getId, getIdentity, getName, getNonRelationshipPropertiesFromPOJO, getPagedRelationalPropertiesFromPOJO, getPropertyByName, getStringPropertiesFromPOJO, getType, getUrl, hasModificationDetails, hasModificationDetails, hasProperty, isCreatableFromPOJO, isFullyRetrieved, isReference, isReference, isReferenceList, isReferenceList, isSimpleType, isSimpleType, populateContext, populateModificationDetails, setContext, setFullyRetrieved, setId, setName, setPropertyByName, setType, setUrl

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter
getAllFields, toString

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

- Field Detail
  - name
```
protected String name
```
    The name property, displayed as 'Name' in the IGC UI.
  - short_description
```
protected String short_description
```
    The short_description property, displayed as 'Short Description' in the IGC UI.
  - long_description
```
protected String long_description
```
    The long_description property, displayed as 'Long Description' in the IGC UI.
  - logical_entity
```
protected Reference logical_entity
```
    The logical_entity property, displayed as 'Logical Entity' in the IGC UI.
    
    Will be a single Reference to a LogicalEntity object.
  - labels
```
protected ReferenceList labels
```
    The labels property, displayed as 'Labels' in the IGC UI.
    
    Will be a ReferenceList of Label objects.
  - stewards
```
protected ReferenceList stewards
```
    The stewards property, displayed as 'Stewards' in the IGC UI.
    
    Will be a ReferenceList of AsclSteward objects.
  - assigned_to_terms
```
protected ReferenceList assigned_to_terms
```
    The assigned_to_terms property, displayed as 'Assigned to Terms' in the IGC UI.
    
    Will be a ReferenceList of Term objects.
  - implements_rules
```
protected ReferenceList implements_rules
```
    The implements_rules property, displayed as 'Implements Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - governed_by_rules
```
protected ReferenceList governed_by_rules
```
    The governed_by_rules property, displayed as 'Governed by Rules' in the IGC UI.
    
    Will be a ReferenceList of InformationGovernanceRule objects.
  - implemented_by_design_columns
```
protected ReferenceList implemented_by_design_columns
```
    The implemented_by_design_columns property, displayed as 'Implemented by Design Columns' in the IGC UI.
    
    Will be a ReferenceList of DesignColumn objects.
  - implemented_by_database_columns
```
protected ReferenceList implemented_by_database_columns
```
    The implemented_by_database_columns property, displayed as 'Implemented by Database Columns' in the IGC UI.
    
    Will be a ReferenceList of DatabaseColumn objects.
  - primary_key
```
protected Boolean primary_key
```
    The primary_key property, displayed as 'Primary Key' in the IGC UI.
  - logical_keys
```
protected ReferenceList logical_keys
```
    The logical_keys property, displayed as 'Logical Keys' in the IGC UI.
    
    Will be a ReferenceList of LogicalKey objects.
  - parent_logical_foreignKey
```
protected ReferenceList parent_logical_foreignKey
```
    The parent_logical_foreignKey property, displayed as 'Parent Logical Foreign Key' in the IGC UI.
    
    Will be a ReferenceList of LogicalForeignKey objects.
  - child_logical_foreign_keys
```
protected ReferenceList child_logical_foreign_keys
```
    The child_logical_foreign_keys property, displayed as 'Child Logical Foreign Keys' in the IGC UI.
    
    Will be a ReferenceList of EntityAttribute objects.
  - validation_rule
```
protected Reference validation_rule
```
    The validation_rule property, displayed as 'Validation Rule' in the IGC UI.
    
    Will be a single Reference to a LogicalValidationRule object.
  - validation_range
```
protected Reference validation_range
```
    The validation_range property, displayed as 'Validation Range' in the IGC UI.
    
    Will be a single Reference to a LogicalValidationRange object.
  - validation_list
```
protected Reference validation_list
```
    The validation_list property, displayed as 'Validation List' in the IGC UI.
    
    Will be a single Reference to a LogicalValidationList object.
  - physical_name
```
protected String physical_name
```
    The physical_name property, displayed as 'Physical Name' in the IGC UI.
  - native_type
```
protected String native_type
```
    The native_type property, displayed as 'Native Type' in the IGC UI.
  - data_type
```
protected String data_type
```
    The data_type property, displayed as 'Data Type' in the IGC UI.
  - length
```
protected Number length
```
    The length property, displayed as 'Length' in the IGC UI.
  - scale
```
protected Number scale
```
    The scale property, displayed as 'Scale' in the IGC UI.
  - required
```
protected Boolean required
```
    The required property, displayed as 'Required' in the IGC UI.
  - sequence
```
protected Number sequence
```
    The sequence property, displayed as 'Sequence' in the IGC UI.
  - in_collections
```
protected ReferenceList in_collections
```
    The in_collections property, displayed as 'In Collections' in the IGC UI.
    
    Will be a ReferenceList of Collection objects.
  - created_by
```
protected String created_by
```
    The created_by property, displayed as 'Created By' in the IGC UI.
  - created_on
```
protected Date created_on
```
    The created_on property, displayed as 'Created On' in the IGC UI.
  - modified_by
```
protected String modified_by
```
    The modified_by property, displayed as 'Modified By' in the IGC UI.
  - modified_on
```
protected Date modified_on
```
    The modified_on property, displayed as 'Modified On' in the IGC UI.
- Constructor Detail
  - EntityAttribute
```
public EntityAttribute()
```
- Method Detail
  - getIgcTypeId
```
public static String getIgcTypeId()
```
  - getIgcTypeDisplayName
```
public static String getIgcTypeDisplayName()
```
  - getTheName
```
public String getTheName()
```
    See Also:
    
    name
  - setTheName
```
public void setTheName(String name)
```
    See Also:
    
    name
  - getShortDescription
```
public String getShortDescription()
```
    See Also:
    
    short_description
  - setShortDescription
```
public void setShortDescription(String short_description)
```
    See Also:
    
    short_description
  - getLongDescription
```
public String getLongDescription()
```
    See Also:
    
    long_description
  - setLongDescription
```
public void setLongDescription(String long_description)
```
    See Also:
    
    long_description
  - getLogicalEntity
```
public Reference getLogicalEntity()
```
    See Also:
    
    logical_entity
  - setLogicalEntity
```
public void setLogicalEntity(Reference logical_entity)
```
    See Also:
    
    logical_entity
  - getLabels
```
public ReferenceList getLabels()
```
    See Also:
    
    labels
  - setLabels
```
public void setLabels(ReferenceList labels)
```
    See Also:
    
    labels
  - getStewards
```
public ReferenceList getStewards()
```
    See Also:
    
    stewards
  - setStewards
```
public void setStewards(ReferenceList stewards)
```
    See Also:
    
    stewards
  - getAssignedToTerms
```
public ReferenceList getAssignedToTerms()
```
    See Also:
    
    assigned_to_terms
  - setAssignedToTerms
```
public void setAssignedToTerms(ReferenceList assigned_to_terms)
```
    See Also:
    
    assigned_to_terms
  - getImplementsRules
```
public ReferenceList getImplementsRules()
```
    See Also:
    
    implements_rules
  - setImplementsRules
```
public void setImplementsRules(ReferenceList implements_rules)
```
    See Also:
    
    implements_rules
  - getGovernedByRules
```
public ReferenceList getGovernedByRules()
```
    See Also:
    
    governed_by_rules
  - setGovernedByRules
```
public void setGovernedByRules(ReferenceList governed_by_rules)
```
    See Also:
    
    governed_by_rules
  - getImplementedByDesignColumns
```
public ReferenceList getImplementedByDesignColumns()
```
    See Also:
    
    implemented_by_design_columns
  - setImplementedByDesignColumns
```
public void setImplementedByDesignColumns(ReferenceList implemented_by_design_columns)
```
    See Also:
    
    implemented_by_design_columns
  - getImplementedByDatabaseColumns
```
public ReferenceList getImplementedByDatabaseColumns()
```
    See Also:
    
    implemented_by_database_columns
  - setImplementedByDatabaseColumns
```
public void setImplementedByDatabaseColumns(ReferenceList implemented_by_database_columns)
```
    See Also:
    
    implemented_by_database_columns
  - getPrimaryKey
```
public Boolean getPrimaryKey()
```
    See Also:
    
    primary_key
  - setPrimaryKey
```
public void setPrimaryKey(Boolean primary_key)
```
    See Also:
    
    primary_key
  - getLogicalKeys
```
public ReferenceList getLogicalKeys()
```
    See Also:
    
    logical_keys
  - setLogicalKeys
```
public void setLogicalKeys(ReferenceList logical_keys)
```
    See Also:
    
    logical_keys
  - getParentLogicalForeignkey
```
public ReferenceList getParentLogicalForeignkey()
```
    See Also:
    
    parent_logical_foreignKey
  - setParentLogicalForeignkey
```
public void setParentLogicalForeignkey(ReferenceList parent_logical_foreignKey)
```
    See Also:
    
    parent_logical_foreignKey
  - getChildLogicalForeignKeys
```
public ReferenceList getChildLogicalForeignKeys()
```
    See Also:
    
    child_logical_foreign_keys
  - setChildLogicalForeignKeys
```
public void setChildLogicalForeignKeys(ReferenceList child_logical_foreign_keys)
```
    See Also:
    
    child_logical_foreign_keys
  - getValidationRule
```
public Reference getValidationRule()
```
    See Also:
    
    validation_rule
  - setValidationRule
```
public void setValidationRule(Reference validation_rule)
```
    See Also:
    
    validation_rule
  - getValidationRange
```
public Reference getValidationRange()
```
    See Also:
    
    validation_range
  - setValidationRange
```
public void setValidationRange(Reference validation_range)
```
    See Also:
    
    validation_range
  - getValidationList
```
public Reference getValidationList()
```
    See Also:
    
    validation_list
  - setValidationList
```
public void setValidationList(Reference validation_list)
```
    See Also:
    
    validation_list
  - getPhysicalName
```
public String getPhysicalName()
```
    See Also:
    
    physical_name
  - setPhysicalName
```
public void setPhysicalName(String physical_name)
```
    See Also:
    
    physical_name
  - getNativeType
```
public String getNativeType()
```
    See Also:
    
    native_type
  - setNativeType
```
public void setNativeType(String native_type)
```
    See Also:
    
    native_type
  - getDataType
```
public String getDataType()
```
    See Also:
    
    data_type
  - setDataType
```
public void setDataType(String data_type)
```
    See Also:
    
    data_type
  - getLength
```
public Number getLength()
```
    See Also:
    
    length
  - setLength
```
public void setLength(Number length)
```
    See Also:
    
    length
  - getScale
```
public Number getScale()
```
    See Also:
    
    scale
  - setScale
```
public void setScale(Number scale)
```
    See Also:
    
    scale
  - getRequired
```
public Boolean getRequired()
```
    See Also:
    
    required
  - setRequired
```
public void setRequired(Boolean required)
```
    See Also:
    
    required
  - getSequence
```
public Number getSequence()
```
    See Also:
    
    sequence
  - setSequence
```
public void setSequence(Number sequence)
```
    See Also:
    
    sequence
  - getInCollections
```
public ReferenceList getInCollections()
```
    See Also:
    
    in_collections
  - setInCollections
```
public void setInCollections(ReferenceList in_collections)
```
    See Also:
    
    in_collections
  - getCreatedBy
```
public String getCreatedBy()
```
    See Also:
    
    created_by
  - setCreatedBy
```
public void setCreatedBy(String created_by)
```
    See Also:
    
    created_by
  - getCreatedOn
```
public Date getCreatedOn()
```
    See Also:
    
    created_on
  - setCreatedOn
```
public void setCreatedOn(Date created_on)
```
    See Also:
    
    created_on
  - getModifiedBy
```
public String getModifiedBy()
```
    See Also:
    
    modified_by
  - setModifiedBy
```
public void setModifiedBy(String modified_by)
```
    See Also:
    
    modified_by
  - getModifiedOn
```
public Date getModifiedOn()
```
    See Also:
    
    modified_on
  - setModifiedOn
```
public void setModifiedOn(Date modified_on)
```
    See Also:
    
    modified_on
  - canBeCreated
```
public static Boolean canBeCreated()
```
  - includesModificationDetails
```
public static Boolean includesModificationDetails()
```
  - getNonRelationshipProperties
```
public static List<String> getNonRelationshipProperties()
```
  - getStringProperties
```
public static List<String> getStringProperties()
```
  - getPagedRelationshipProperties
```
public static List<String> getPagedRelationshipProperties()
```
  - getAllProperties
```
public static List<String> getAllProperties()
```
  - isEntityAttribute
```
public static Boolean isEntityAttribute(Object obj)
```

Class EntityAttribute

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.Reference

Methods inherited from class org.odpi.openmetadata.adapters.repositoryservices.igc.clientlibrary.model.common.ObjectPrinter

Methods inherited from class java.lang.Object

Field Detail

name

short_description

long_description

logical_entity

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

implemented_by_design_columns

implemented_by_database_columns

primary_key

logical_keys

parent_logical_foreignKey

child_logical_foreign_keys

validation_rule

validation_range

validation_list

physical_name

native_type

data_type

length

scale

required

sequence

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

EntityAttribute

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLogicalEntity

setLogicalEntity

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getImplementedByDesignColumns

setImplementedByDesignColumns

getImplementedByDatabaseColumns

setImplementedByDatabaseColumns

getPrimaryKey

setPrimaryKey

getLogicalKeys

setLogicalKeys

getParentLogicalForeignkey

setParentLogicalForeignkey

getChildLogicalForeignKeys

setChildLogicalForeignKeys

getValidationRule

setValidationRule

getValidationRange

setValidationRange

getValidationList

setValidationList