Notebook (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.v11701.Notebook

```
public class Notebook
extends Reference
```
POJO for the notebook asset type in IGC, displayed as 'Notebook' 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 Reference`	`analytics_project` The `analytics_project` property, displayed as 'Data Science Project' 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 String`	`environment` The `environment` property, displayed as 'Environment' in the IGC UI.
`protected Date`	`first_published_date` The `first_published_date` property, displayed as 'First Published Date' 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`	`input_training_notebook_inv` The `input_training_notebook_inv` property, displayed as 'Data Science Models' in the IGC UI.
`protected ReferenceList`	`labels` The `labels` property, displayed as 'Labels' in the IGC UI.
`protected String`	`logical_name` The `logical_name` property, displayed as 'Logical Name' in the IGC UI.
`protected String`	`long_description` The `long_description` property, displayed as 'Long Description' in the IGC UI.
`protected ReferenceList`	`model_input_training_column` The `model_input_training_column` property, displayed as 'Data Assets' 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`	`package_name` The `package_name` property, displayed as 'Package Name' 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 String`	`system_equiv_id` The `system_equiv_id` property, displayed as 'System Equiv Id' in the IGC UI.
`protected String`	`tool` The `tool` property, displayed as 'Tool' 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

Notebook()

Constructors
Constructor and Description
`Notebook()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Boolean`	`canBeCreated()`
`static List<String>`	`getAllProperties()`
`Reference`	`getAnalyticsProject()`
`ReferenceList`	`getAssignedToTerms()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`String`	`getEnvironment()`
`Date`	`getFirstPublishedDate()`
`ReferenceList`	`getGovernedByRules()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getInputTrainingNotebookInv()`
`ReferenceList`	`getLabels()`
`String`	`getLogicalName()`
`String`	`getLongDescription()`
`ReferenceList`	`getModelInputTrainingColumn()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`String`	`getPackageName()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getShortDescription()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getSystemEquivId()`
`String`	`getTheName()`
`String`	`getTheUrl()`
`String`	`getTool()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isNotebook(Object obj)`
`void`	`setAnalyticsProject(Reference analytics_project)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setEnvironment(String environment)`
`void`	`setFirstPublishedDate(Date first_published_date)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`void`	`setInCollections(ReferenceList in_collections)`
`void`	`setInputTrainingNotebookInv(ReferenceList input_training_notebook_inv)`
`void`	`setLabels(ReferenceList labels)`
`void`	`setLogicalName(String logical_name)`
`void`	`setLongDescription(String long_description)`
`void`	`setModelInputTrainingColumn(ReferenceList model_input_training_column)`
`void`	`setModifiedBy(String modified_by)`
`void`	`setModifiedOn(Date modified_on)`
`void`	`setPackageName(String package_name)`
`void`	`setShortDescription(String short_description)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setSystemEquivId(String system_equiv_id)`
`void`	`setTheName(String name)`
`void`	`setTheUrl(String url)`
`void`	`setTool(String tool)`

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.
  - analytics_project
```
protected Reference analytics_project
```
    The analytics_project property, displayed as 'Data Science Project' in the IGC UI.
    
    Will be a single Reference to a AnalyticsProject 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.
  - input_training_notebook_inv
```
protected ReferenceList input_training_notebook_inv
```
    The input_training_notebook_inv property, displayed as 'Data Science Models' in the IGC UI.
    
    Will be a ReferenceList of AnalyticsModel objects.
  - model_input_training_column
```
protected ReferenceList model_input_training_column
```
    The model_input_training_column property, displayed as 'Data Assets' in the IGC UI.
    
    Will be a ReferenceList of DataField objects.
  - system_equiv_id
```
protected String system_equiv_id
```
    The system_equiv_id property, displayed as 'System Equiv Id' in the IGC UI.
  - first_published_date
```
protected Date first_published_date
```
    The first_published_date property, displayed as 'First Published Date' in the IGC UI.
  - package_name
```
protected String package_name
```
    The package_name property, displayed as 'Package Name' in the IGC UI.
  - logical_name
```
protected String logical_name
```
    The logical_name property, displayed as 'Logical Name' in the IGC UI.
  - url
```
protected String url
```
    The url property, displayed as 'URL' in the IGC UI.
  - environment
```
protected String environment
```
    The environment property, displayed as 'Environment' in the IGC UI.
  - tool
```
protected String tool
```
    The tool property, displayed as 'Tool' 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
  - Notebook
```
public Notebook()
```
- 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
  - getAnalyticsProject
```
public Reference getAnalyticsProject()
```
    See Also:
    
    analytics_project
  - setAnalyticsProject
```
public void setAnalyticsProject(Reference analytics_project)
```
    See Also:
    
    analytics_project
  - 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
  - getInputTrainingNotebookInv
```
public ReferenceList getInputTrainingNotebookInv()
```
    See Also:
    
    input_training_notebook_inv
  - setInputTrainingNotebookInv
```
public void setInputTrainingNotebookInv(ReferenceList input_training_notebook_inv)
```
    See Also:
    
    input_training_notebook_inv
  - getModelInputTrainingColumn
```
public ReferenceList getModelInputTrainingColumn()
```
    See Also:
    
    model_input_training_column
  - setModelInputTrainingColumn
```
public void setModelInputTrainingColumn(ReferenceList model_input_training_column)
```
    See Also:
    
    model_input_training_column
  - getSystemEquivId
```
public String getSystemEquivId()
```
    See Also:
    
    system_equiv_id
  - setSystemEquivId
```
public void setSystemEquivId(String system_equiv_id)
```
    See Also:
    
    system_equiv_id
  - getFirstPublishedDate
```
public Date getFirstPublishedDate()
```
    See Also:
    
    first_published_date
  - setFirstPublishedDate
```
public void setFirstPublishedDate(Date first_published_date)
```
    See Also:
    
    first_published_date
  - getPackageName
```
public String getPackageName()
```
    See Also:
    
    package_name
  - setPackageName
```
public void setPackageName(String package_name)
```
    See Also:
    
    package_name
  - getLogicalName
```
public String getLogicalName()
```
    See Also:
    
    logical_name
  - setLogicalName
```
public void setLogicalName(String logical_name)
```
    See Also:
    
    logical_name
  - getTheUrl
```
public String getTheUrl()
```
    See Also:
    
    url
  - setTheUrl
```
public void setTheUrl(String url)
```
    See Also:
    
    url
  - getEnvironment
```
public String getEnvironment()
```
    See Also:
    
    environment
  - setEnvironment
```
public void setEnvironment(String environment)
```
    See Also:
    
    environment
  - getTool
```
public String getTool()
```
    See Also:
    
    tool
  - setTool
```
public void setTool(String tool)
```
    See Also:
    
    tool
  - 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()
```
  - isNotebook
```
public static Boolean isNotebook(Object obj)
```

Class Notebook

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

analytics_project

short_description

long_description

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

input_training_notebook_inv

model_input_training_column

system_equiv_id

first_published_date

package_name

logical_name

url

environment

tool

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

Notebook

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getAnalyticsProject

setAnalyticsProject

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getInputTrainingNotebookInv

setInputTrainingNotebookInv

getModelInputTrainingColumn

setModelInputTrainingColumn

getSystemEquivId

setSystemEquivId

getFirstPublishedDate

setFirstPublishedDate

getPackageName

setPackageName

getLogicalName

setLogicalName

getTheUrl

setTheUrl

getEnvironment

setEnvironment

getTool

setTool

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy