Volume (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.Volume

```
public class Volume
extends Reference
```
POJO for the volume asset type in IGC, displayed as 'Volume' 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`	`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_server` The `data_server` property, displayed as 'Data Server' 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 ReferenceList`	`infosets` The `infosets` property, displayed as 'InfoSets' in the IGC UI.
`protected Reference`	`instance` The `instance` property, displayed as 'Instance' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected Date`	`last_harvested` The `last_harvested` property, displayed as 'Last Harvest Date' 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 Number`	`object_count` The `object_count` property, displayed as 'Number of Objects' in the IGC UI.
`protected String`	`server_name` The `server_name` property, displayed as 'Server' in the IGC UI.
`protected String`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected Number`	`size` The `size` property, displayed as 'Size (Bytes)' in the IGC UI.
`protected String`	`source_type` The `source_type` property, displayed as 'Source Type' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected String`	`sync_state` The `sync_state` property, displayed as 'State' in the IGC UI.
`protected String`	`tool_id` The `tool_id` property, displayed as 'Tool ID' in the IGC UI.
`protected String`	`type` The `type` property, displayed as 'Type' in the IGC UI.
`protected String`	`url` The `url` property, displayed as 'URL' 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

Volume()

Constructors
Constructor and Description
`Volume()`

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`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getDataServer()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getInfosets()`
`Reference`	`getInstance()`
`ReferenceList`	`getLabels()`
`Date`	`getLastHarvested()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`Number`	`getObjectCount()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getServerName()`
`String`	`getShortDescription()`
`Number`	`getSize()`
`String`	`getSourceType()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getSyncState()`
`String`	`getTheName()`
`String`	`getTheType()`
`String`	`getTheUrl()`
`String`	`getToolId()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isVolume(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataServer(String data_server)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setInfosets(ReferenceList infosets)`
`void`	`setInstance(Reference instance)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLastHarvested(Date last_harvested)`
`void`	`setLongDescription(String long_description)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setObjectCount(Number object_count)`
`void`	`setServerName(String server_name)`
`void`	`setShortDescription(String short_description)`
`void`	`setSize(Number size)`
`void`	`setSourceType(String source_type)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setSyncState(String sync_state)`
`void`	`setTheName(String name)`
`void`	`setTheType(String type)`
`void`	`setTheUrl(String url)`
`void`	`setToolId(String tool_id)`

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.
  - instance
```
protected Reference instance
```
    The instance property, displayed as 'Instance' in the IGC UI.
    
    Will be a single Reference to a Instance object.
  - 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.
  - data_server
```
protected String data_server
```
    The data_server property, displayed as 'Data Server' in the IGC UI.
  - type
```
protected String type
```
    The type property, displayed as 'Type' in the IGC UI.
    
    Can be one of the following values:
    - Primary (displayed in the UI as 'Primary')
    - Retention (displayed in the UI as 'Retention')
    - Discovery (displayed in the UI as 'Discovery')
    - Export (displayed in the UI as 'Export')
  - source_type
```
protected String source_type
```
    The source_type property, displayed as 'Source Type' in the IGC UI.
  - server_name
```
protected String server_name
```
    The server_name property, displayed as 'Server' in the IGC UI.
  - object_count
```
protected Number object_count
```
    The object_count property, displayed as 'Number of Objects' in the IGC UI.
  - size
```
protected Number size
```
    The size property, displayed as 'Size (Bytes)' in the IGC UI.
  - last_harvested
```
protected Date last_harvested
```
    The last_harvested property, displayed as 'Last Harvest Date' in the IGC UI.
  - tool_id
```
protected String tool_id
```
    The tool_id property, displayed as 'Tool ID' in the IGC UI.
  - sync_state
```
protected String sync_state
```
    The sync_state property, displayed as 'State' in the IGC UI.
  - url
```
protected String url
```
    The url property, displayed as 'URL' in the IGC UI.
  - infosets
```
protected ReferenceList infosets
```
    The infosets property, displayed as 'InfoSets' in the IGC UI.
    
    Will be a ReferenceList of Infoset objects.
  - 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
  - Volume
```
public Volume()
```
- 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
  - getInstance
```
public Reference getInstance()
```
    See Also:
    
    instance
  - setInstance
```
public void setInstance(Reference instance)
```
    See Also:
    
    instance
  - 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
  - getDataServer
```
public String getDataServer()
```
    See Also:
    
    data_server
  - setDataServer
```
public void setDataServer(String data_server)
```
    See Also:
    
    data_server
  - getTheType
```
public String getTheType()
```
    See Also:
    
    type
  - setTheType
```
public void setTheType(String type)
```
    See Also:
    
    type
  - getSourceType
```
public String getSourceType()
```
    See Also:
    
    source_type
  - setSourceType
```
public void setSourceType(String source_type)
```
    See Also:
    
    source_type
  - getServerName
```
public String getServerName()
```
    See Also:
    
    server_name
  - setServerName
```
public void setServerName(String server_name)
```
    See Also:
    
    server_name
  - getObjectCount
```
public Number getObjectCount()
```
    See Also:
    
    object_count
  - setObjectCount
```
public void setObjectCount(Number object_count)
```
    See Also:
    
    object_count
  - getSize
```
public Number getSize()
```
    See Also:
    
    size
  - setSize
```
public void setSize(Number size)
```
    See Also:
    
    size
  - getLastHarvested
```
public Date getLastHarvested()
```
    See Also:
    
    last_harvested
  - setLastHarvested
```
public void setLastHarvested(Date last_harvested)
```
    See Also:
    
    last_harvested
  - getToolId
```
public String getToolId()
```
    See Also:
    
    tool_id
  - setToolId
```
public void setToolId(String tool_id)
```
    See Also:
    
    tool_id
  - getSyncState
```
public String getSyncState()
```
    See Also:
    
    sync_state
  - setSyncState
```
public void setSyncState(String sync_state)
```
    See Also:
    
    sync_state
  - getTheUrl
```
public String getTheUrl()
```
    See Also:
    
    url
  - setTheUrl
```
public void setTheUrl(String url)
```
    See Also:
    
    url
  - getInfosets
```
public ReferenceList getInfosets()
```
    See Also:
    
    infosets
  - setInfosets
```
public void setInfosets(ReferenceList infosets)
```
    See Also:
    
    infosets
  - 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()
```
  - isVolume
```
public static Boolean isVolume(Object obj)
```

Class Volume

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

instance

short_description

long_description

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

data_server

type

source_type

server_name

object_count

size

last_harvested

tool_id

sync_state

url

infosets

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

Volume

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getInstance

setInstance

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getDataServer

setDataServer

getTheType

setTheType

getSourceType

setSourceType

getServerName

setServerName

getObjectCount

setObjectCount

getSize

setSize

getLastHarvested

setLastHarvested

getToolId

setToolId

getSyncState

setSyncState

getTheUrl

setTheUrl

getInfosets

setInfosets

getInCollections