Host (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.v11700.Host

Direct Known Subclasses:

HostEngine
```
public class Host
extends Reference
```
POJO for the host asset type in IGC, displayed as 'Host' 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`	`amazon_s3_buckets` The `amazon_s3_buckets` property, displayed as 'Amazon S3 Buckets' in the IGC UI.
`protected ReferenceList`	`assigned_to_terms` The `assigned_to_terms` property, displayed as 'Assigned to Terms' 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 ReferenceList`	`data_connections` The `data_connections` property, displayed as 'Data Connections' in the IGC UI.
`protected ReferenceList`	`data_file_folders` The `data_file_folders` property, displayed as 'Data File Folders' in the IGC UI.
`protected ReferenceList`	`data_files` The `data_files` property, displayed as 'Data Files' in the IGC UI.
`protected ReferenceList`	`databases` The `databases` property, displayed as 'Databases' 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`	`idoc_types` The `idoc_types` property, displayed as 'IDoc Types' in the IGC UI.
`protected ReferenceList`	`implements_rules` The `implements_rules` property, displayed as 'Implements Rules' in the IGC UI.
`protected String`	`imported_from` The `imported_from` property, displayed as 'Imported From' 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 String`	`location` The `location` property, displayed as 'Location' 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`	`network_node` The `network_node` property, displayed as 'Network Node' 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 ReferenceList`	`transformation_projects` The `transformation_projects` property, displayed as 'Transformation Projects' 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

Host()

Constructors
Constructor and Description
`Host()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`ReferenceList`	`getAmazonS3Buckets()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getDatabases()`
`ReferenceList`	`getDataConnections()`
`ReferenceList`	`getDataFileFolders()`
`ReferenceList`	`getDataFiles()`
`ReferenceList`	`getGovernedByRules()`
`ReferenceList`	`getIdocTypes()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`String`	`getImportedFrom()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLocation()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`String`	`getNetworkNode()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`ReferenceList`	`getTransformationProjects()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isHost(Object obj)`
`void`	`setAmazonS3Buckets(ReferenceList amazon_s3_buckets)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDatabases(ReferenceList databases)`
`void`	`setDataConnections(ReferenceList data_connections)`
`void`	`setDataFileFolders(ReferenceList data_file_folders)`
`void`	`setDataFiles(ReferenceList data_files)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setIdocTypes(ReferenceList idoc_types)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setImportedFrom(String imported_from)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLocation(String location)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setNetworkNode(String network_node)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setTransformationProjects(ReferenceList transformation_projects)`

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.
  - 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.
  - databases
```
protected ReferenceList databases
```
    The databases property, displayed as 'Databases' in the IGC UI.
    
    Will be a ReferenceList of Database objects.
  - data_files
```
protected ReferenceList data_files
```
    The data_files property, displayed as 'Data Files' in the IGC UI.
    
    Will be a ReferenceList of DataFile objects.
  - idoc_types
```
protected ReferenceList idoc_types
```
    The idoc_types property, displayed as 'IDoc Types' in the IGC UI.
    
    Will be a ReferenceList of IdocType objects.
  - transformation_projects
```
protected ReferenceList transformation_projects
```
    The transformation_projects property, displayed as 'Transformation Projects' in the IGC UI.
    
    Will be a ReferenceList of TransformationProject objects.
  - data_connections
```
protected ReferenceList data_connections
```
    The data_connections property, displayed as 'Data Connections' in the IGC UI.
    
    Will be a ReferenceList of Connector objects.
  - amazon_s3_buckets
```
protected ReferenceList amazon_s3_buckets
```
    The amazon_s3_buckets property, displayed as 'Amazon S3 Buckets' in the IGC UI.
    
    Will be a ReferenceList of AmazonS3Bucket objects.
  - data_file_folders
```
protected ReferenceList data_file_folders
```
    The data_file_folders property, displayed as 'Data File Folders' in the IGC UI.
    
    Will be a ReferenceList of DataFileFolder objects.
  - location
```
protected String location
```
    The location property, displayed as 'Location' in the IGC UI.
  - network_node
```
protected String network_node
```
    The network_node property, displayed as 'Network Node' in the IGC UI.
  - imported_from
```
protected String imported_from
```
    The imported_from property, displayed as 'Imported From' 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
  - Host
```
public Host()
```
- 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
  - 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
  - getDatabases
```
public ReferenceList getDatabases()
```
    See Also:
    
    databases
  - setDatabases
```
public void setDatabases(ReferenceList databases)
```
    See Also:
    
    databases
  - getDataFiles
```
public ReferenceList getDataFiles()
```
    See Also:
    
    data_files
  - setDataFiles
```
public void setDataFiles(ReferenceList data_files)
```
    See Also:
    
    data_files
  - getIdocTypes
```
public ReferenceList getIdocTypes()
```
    See Also:
    
    idoc_types
  - setIdocTypes
```
public void setIdocTypes(ReferenceList idoc_types)
```
    See Also:
    
    idoc_types
  - getTransformationProjects
```
public ReferenceList getTransformationProjects()
```
    See Also:
    
    transformation_projects
  - setTransformationProjects
```
public void setTransformationProjects(ReferenceList transformation_projects)
```
    See Also:
    
    transformation_projects
  - getDataConnections
```
public ReferenceList getDataConnections()
```
    See Also:
    
    data_connections
  - setDataConnections
```
public void setDataConnections(ReferenceList data_connections)
```
    See Also:
    
    data_connections
  - getAmazonS3Buckets
```
public ReferenceList getAmazonS3Buckets()
```
    See Also:
    
    amazon_s3_buckets
  - setAmazonS3Buckets
```
public void setAmazonS3Buckets(ReferenceList amazon_s3_buckets)
```
    See Also:
    
    amazon_s3_buckets
  - getDataFileFolders
```
public ReferenceList getDataFileFolders()
```
    See Also:
    
    data_file_folders
  - setDataFileFolders
```
public void setDataFileFolders(ReferenceList data_file_folders)
```
    See Also:
    
    data_file_folders
  - getLocation
```
public String getLocation()
```
    See Also:
    
    location
  - setLocation
```
public void setLocation(String location)
```
    See Also:
    
    location
  - getNetworkNode
```
public String getNetworkNode()
```
    See Also:
    
    network_node
  - setNetworkNode
```
public void setNetworkNode(String network_node)
```
    See Also:
    
    network_node
  - getImportedFrom
```
public String getImportedFrom()
```
    See Also:
    
    imported_from
  - setImportedFrom
```
public void setImportedFrom(String imported_from)
```
    See Also:
    
    imported_from
  - 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()
```
  - isHost
```
public static Boolean isHost(Object obj)
```

Class Host

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

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

databases

data_files

idoc_types

transformation_projects

data_connections

amazon_s3_buckets

data_file_folders

location

network_node

imported_from

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

Host

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getDatabases

setDatabases

getDataFiles

setDataFiles

getIdocTypes

setIdocTypes

getTransformationProjects

setTransformationProjects

getDataConnections

setDataConnections

getAmazonS3Buckets

setAmazonS3Buckets

getDataFileFolders

setDataFileFolders

getLocation

setLocation

getNetworkNode

setNetworkNode

getImportedFrom

setImportedFrom

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy