DataClass (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.v11501ru5.DataClass

```
public class DataClass
extends Reference
```
POJO for the data_class asset type in IGC, displayed as 'Data Class' 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 String`	`class_code` The `class_code` property, displayed as 'Class Code' in the IGC UI.
`protected ReferenceList`	`classifications_selected` The `classifications_selected` property, displayed as 'Selected Data Classifications' in the IGC UI.
`protected ReferenceList`	`classified_assets_detected` The `classified_assets_detected` property, displayed as 'Detected Data Classifications' in the IGC UI.
`protected ReferenceList`	`contains_data_classes` The `contains_data_classes` property, displayed as 'Contains Data Classes' 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_class_type_single` The `data_class_type_single` property, displayed as 'Type' in the IGC UI.
`protected ArrayList<String>`	`data_type_filter_elements_enum` The `data_type_filter_elements_enum` property, displayed as 'Data Type' in the IGC UI.
`protected Number`	`default_threshold` The `default_threshold` property, displayed as 'Threshold (Percent)' in the IGC UI.
`protected Boolean`	`enabled` The `enabled` property, displayed as 'Enabled' in the IGC UI.
`protected String`	`example` The `example` property, displayed as 'Example' 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`	`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 String`	`java_class_name_single` The `java_class_name_single` property, displayed as 'JAVA Class' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Number`	`length_filter_max` The `length_filter_max` property, displayed as 'Maximum Data Length' in the IGC UI.
`protected Number`	`length_filter_min` The `length_filter_min` property, displayed as 'Minimum Data Length' 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 Reference`	`parent_data_class` The `parent_data_class` property, displayed as 'Parent Data Class' in the IGC UI.
`protected String`	`regular_expression_single` The `regular_expression_single` property, displayed as 'Regular Expression' 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 ArrayList<String>`	`valid_value_strings` The `valid_value_strings` property, displayed as 'Valid Values' in the IGC UI.
`protected Boolean`	`valid_values_case_sensitive` The `valid_values_case_sensitive` property, displayed as 'Case Sensitive' 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

DataClass()

Constructors
Constructor and Description
`DataClass()`

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()`
`String`	`getClassCode()`
`ReferenceList`	`getClassificationsSelected()`
`ReferenceList`	`getClassifiedAssetsDetected()`
`ReferenceList`	`getContainsDataClasses()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDataClassTypeSingle()`
`ArrayList<String>`	`getDataTypeFilterElementsEnum()`
`Number`	`getDefaultThreshold()`
`Boolean`	`getEnabled()`
`String`	`getExample()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`String`	`getJavaClassNameSingle()`
`ReferenceList`	`getLabels()`
`Number`	`getLengthFilterMax()`
`Number`	`getLengthFilterMin()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`Reference`	`getParentDataClass()`
`String`	`getRegularExpressionSingle()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`Boolean`	`getValidValuesCaseSensitive()`
`ArrayList<String>`	`getValidValueStrings()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isDataClass(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setClassCode(String class_code)`
`void`	`setClassificationsSelected(ReferenceList classifications_selected)`
`void`	`setClassifiedAssetsDetected(ReferenceList classified_assets_detected)`
`void`	`setContainsDataClasses(ReferenceList contains_data_classes)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataClassTypeSingle(String data_class_type_single)`
`void`	`setDataTypeFilterElementsEnum(ArrayList<String> data_type_filter_elements_enum)`
`void`	`setDefaultThreshold(Number default_threshold)`
`void`	`setEnabled(Boolean enabled)`
`void`	`setExample(String example)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setJavaClassNameSingle(String java_class_name_single)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLengthFilterMax(Number length_filter_max)`
`void`	`setLengthFilterMin(Number length_filter_min)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setParentDataClass(Reference parent_data_class)`
`void`	`setRegularExpressionSingle(String regular_expression_single)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setValidValuesCaseSensitive(Boolean valid_values_case_sensitive)`
`void`	`setValidValueStrings(ArrayList<String> valid_value_strings)`

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.
  - parent_data_class
```
protected Reference parent_data_class
```
    The parent_data_class property, displayed as 'Parent Data Class' in the IGC UI.
    
    Will be a single Reference to a DataClass object.
  - data_class_type_single
```
protected String data_class_type_single
```
    The data_class_type_single property, displayed as 'Type' in the IGC UI.
    
    Can be one of the following values:
    - Undefined (displayed in the UI as 'Unspecified')
    - Regex (displayed in the UI as 'Regex')
    - ValidValues (displayed in the UI as 'Valid Values')
  - 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.
  - contains_data_classes
```
protected ReferenceList contains_data_classes
```
    The contains_data_classes property, displayed as 'Contains Data Classes' in the IGC UI.
    
    Will be a ReferenceList of DataClass objects.
  - classifications_selected
```
protected ReferenceList classifications_selected
```
    The classifications_selected property, displayed as 'Selected Data Classifications' in the IGC UI.
    
    Will be a ReferenceList of Classificationenabledgroup objects.
  - classified_assets_detected
```
protected ReferenceList classified_assets_detected
```
    The classified_assets_detected property, displayed as 'Detected Data Classifications' in the IGC UI.
    
    Will be a ReferenceList of Classification objects.
  - data_type_filter_elements_enum
```
protected ArrayList<String> data_type_filter_elements_enum
```
    The data_type_filter_elements_enum property, displayed as 'Data Type' in the IGC UI.
    
    Can be one of the following values:
    - numeric (displayed in the UI as 'Numeric')
    - string (displayed in the UI as 'String')
    - date (displayed in the UI as 'Date')
    - time (displayed in the UI as 'Time')
    - timestamp (displayed in the UI as 'Timestamp')
  - default_threshold
```
protected Number default_threshold
```
    The default_threshold property, displayed as 'Threshold (Percent)' in the IGC UI.
  - length_filter_min
```
protected Number length_filter_min
```
    The length_filter_min property, displayed as 'Minimum Data Length' in the IGC UI.
  - length_filter_max
```
protected Number length_filter_max
```
    The length_filter_max property, displayed as 'Maximum Data Length' in the IGC UI.
  - java_class_name_single
```
protected String java_class_name_single
```
    The java_class_name_single property, displayed as 'JAVA Class' in the IGC UI.
  - regular_expression_single
```
protected String regular_expression_single
```
    The regular_expression_single property, displayed as 'Regular Expression' in the IGC UI.
  - valid_value_strings
```
protected ArrayList<String> valid_value_strings
```
    The valid_value_strings property, displayed as 'Valid Values' in the IGC UI.
  - valid_values_case_sensitive
```
protected Boolean valid_values_case_sensitive
```
    The valid_values_case_sensitive property, displayed as 'Case Sensitive' in the IGC UI.
  - example
```
protected String example
```
    The example property, displayed as 'Example' in the IGC UI.
  - enabled
```
protected Boolean enabled
```
    The enabled property, displayed as 'Enabled' in the IGC UI.
  - class_code
```
protected String class_code
```
    The class_code property, displayed as 'Class Code' 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
  - DataClass
```
public DataClass()
```
- 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
  - getParentDataClass
```
public Reference getParentDataClass()
```
    See Also:
    
    parent_data_class
  - setParentDataClass
```
public void setParentDataClass(Reference parent_data_class)
```
    See Also:
    
    parent_data_class
  - getDataClassTypeSingle
```
public String getDataClassTypeSingle()
```
    See Also:
    
    data_class_type_single
  - setDataClassTypeSingle
```
public void setDataClassTypeSingle(String data_class_type_single)
```
    See Also:
    
    data_class_type_single
  - 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
  - getContainsDataClasses
```
public ReferenceList getContainsDataClasses()
```
    See Also:
    
    contains_data_classes
  - setContainsDataClasses
```
public void setContainsDataClasses(ReferenceList contains_data_classes)
```
    See Also:
    
    contains_data_classes
  - getClassificationsSelected
```
public ReferenceList getClassificationsSelected()
```
    See Also:
    
    classifications_selected
  - setClassificationsSelected
```
public void setClassificationsSelected(ReferenceList classifications_selected)
```
    See Also:
    
    classifications_selected
  - getClassifiedAssetsDetected
```
public ReferenceList getClassifiedAssetsDetected()
```
    See Also:
    
    classified_assets_detected
  - setClassifiedAssetsDetected
```
public void setClassifiedAssetsDetected(ReferenceList classified_assets_detected)
```
    See Also:
    
    classified_assets_detected
  - getDataTypeFilterElementsEnum
```
public ArrayList<String> getDataTypeFilterElementsEnum()
```
    See Also:
    
    data_type_filter_elements_enum
  - setDataTypeFilterElementsEnum
```
public void setDataTypeFilterElementsEnum(ArrayList<String> data_type_filter_elements_enum)
```
    See Also:
    
    data_type_filter_elements_enum
  - getDefaultThreshold
```
public Number getDefaultThreshold()
```
    See Also:
    
    default_threshold
  - setDefaultThreshold
```
public void setDefaultThreshold(Number default_threshold)
```
    See Also:
    
    default_threshold
  - getLengthFilterMin
```
public Number getLengthFilterMin()
```
    See Also:
    
    length_filter_min
  - setLengthFilterMin
```
public void setLengthFilterMin(Number length_filter_min)
```
    See Also:
    
    length_filter_min
  - getLengthFilterMax
```
public Number getLengthFilterMax()
```
    See Also:
    
    length_filter_max
  - setLengthFilterMax
```
public void setLengthFilterMax(Number length_filter_max)
```
    See Also:
    
    length_filter_max
  - getJavaClassNameSingle
```
public String getJavaClassNameSingle()
```
    See Also:
    
    java_class_name_single
  - setJavaClassNameSingle
```
public void setJavaClassNameSingle(String java_class_name_single)
```
    See Also:
    
    java_class_name_single
  - getRegularExpressionSingle
```
public String getRegularExpressionSingle()
```
    See Also:
    
    regular_expression_single
  - setRegularExpressionSingle
```
public void setRegularExpressionSingle(String regular_expression_single)
```
    See Also:
    
    regular_expression_single
  - getValidValueStrings
```
public ArrayList<String> getValidValueStrings()
```
    See Also:
    
    valid_value_strings
  - setValidValueStrings
```
public void setValidValueStrings(ArrayList<String> valid_value_strings)
```
    See Also:
    
    valid_value_strings
  - getValidValuesCaseSensitive
```
public Boolean getValidValuesCaseSensitive()
```
    See Also:
    
    valid_values_case_sensitive
  - setValidValuesCaseSensitive
```
public void setValidValuesCaseSensitive(Boolean valid_values_case_sensitive)
```
    See Also:
    
    valid_values_case_sensitive
  - getExample
```
public String getExample()
```
    See Also:
    
    example
  - setExample
```
public void setExample(String example)
```
    See Also:
    
    example
  - getEnabled
```
public Boolean getEnabled()
```
    See Also:
    
    enabled
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    See Also:
    
    enabled
  - getClassCode
```
public String getClassCode()
```
    See Also:
    
    class_code
  - setClassCode
```
public void setClassCode(String class_code)
```
    See Also:
    
    class_code
  - 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()
```
  - isDataClass
```
public static Boolean isDataClass(Object obj)
```

Class DataClass

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

parent_data_class

data_class_type_single

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

contains_data_classes

classifications_selected

classified_assets_detected

data_type_filter_elements_enum

default_threshold

length_filter_min

length_filter_max

java_class_name_single

regular_expression_single

valid_value_strings

valid_values_case_sensitive

example

enabled

class_code

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

DataClass

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getParentDataClass

setParentDataClass

getDataClassTypeSingle

setDataClassTypeSingle

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getContainsDataClasses

setContainsDataClasses

getClassificationsSelected

setClassificationsSelected

getClassifiedAssetsDetected

setClassifiedAssetsDetected

getDataTypeFilterElementsEnum

setDataTypeFilterElementsEnum

getDefaultThreshold

setDefaultThreshold

getLengthFilterMin

setLengthFilterMin

getLengthFilterMax

setLengthFilterMax

getJavaClassNameSingle

setJavaClassNameSingle

getRegularExpressionSingle