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

```
public class AmazonS3Bucket
extends Reference
```
POJO for the amazon_s3_bucket asset type in IGC, displayed as 'Amazon S3 Bucket' 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`	`contains_amazon_s3_data_file_folders` The `contains_amazon_s3_data_file_folders` property, displayed as 'Contains Amazon S3 Data File Folders' in the IGC UI.
`protected ReferenceList`	`contains_amazon_s3_data_files` The `contains_amazon_s3_data_files` property, displayed as 'Contains Amazon S3 Data Files' 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_connection` The `data_connection` property, displayed as 'Data Connection' in the IGC UI.
`protected ReferenceList`	`governed_by_rules` The `governed_by_rules` property, displayed as 'Governed by Rules' in the IGC UI.
`protected Reference`	`host` The `host` property, displayed as 'Host' 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 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`	`short_description` The `short_description` property, displayed as 'Short Description' in the IGC UI.
`protected Date`	`source_creation_date` The `source_creation_date` property, displayed as 'Source Creation Date' in the IGC UI.
`protected Date`	`source_modification_date` The `source_modification_date` property, displayed as 'Source Modification Date' in the IGC UI.
`protected ReferenceList`	`stewards` The `stewards` property, displayed as 'Stewards' in the IGC UI.
`protected ReferenceList`	`uses_data_file_definitions` The `uses_data_file_definitions` property, displayed as 'Uses Data File Definitions' 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

AmazonS3Bucket()

Constructors
Constructor and Description
`AmazonS3Bucket()`

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`	`getContainsAmazonS3DataFileFolders()`
`ReferenceList`	`getContainsAmazonS3DataFiles()`
`String`	`getCreatedBy()`
`Date`	`getCreatedOn()`
`ReferenceList`	`getDataConnection()`
`ReferenceList`	`getGovernedByRules()`
`Reference`	`getHost()`
`static String`	`getIgcTypeDisplayName()`
`static String`	`getIgcTypeId()`
`ReferenceList`	`getImplementsRules()`
`ReferenceList`	`getInCollections()`
`ReferenceList`	`getLabels()`
`String`	`getLocation()`
`String`	`getLongDescription()`
`String`	`getModifiedBy()`
`Date`	`getModifiedOn()`
`static List<String>`	`getNonRelationshipProperties()`
`static List<String>`	`getPagedRelationshipProperties()`
`String`	`getShortDescription()`
`Date`	`getSourceCreationDate()`
`Date`	`getSourceModificationDate()`
`ReferenceList`	`getStewards()`
`static List<String>`	`getStringProperties()`
`String`	`getTheName()`
`ReferenceList`	`getUsesDataFileDefinitions()`
`static Boolean`	`includesModificationDetails()`
`static Boolean`	`isAmazonS3Bucket(Object obj)`
`void`	`setAssignedToTerms(ReferenceList assigned_to_terms)`
`void`	`setContainsAmazonS3DataFileFolders(ReferenceList contains_amazon_s3_data_file_folders)`
`void`	`setContainsAmazonS3DataFiles(ReferenceList contains_amazon_s3_data_files)`
`void`	`setCreatedBy(String created_by)`
`void`	`setCreatedOn(Date created_on)`
`void`	`setDataConnection(ReferenceList data_connection)`
`void`	`setGovernedByRules(ReferenceList governed_by_rules)`
`void`	`setHost(Reference host)`
`void`	`setImplementsRules(ReferenceList implements_rules)`
`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`	`setShortDescription(String short_description)`
`void`	`setSourceCreationDate(Date source_creation_date)`
`void`	`setSourceModificationDate(Date source_modification_date)`
`void`	`setStewards(ReferenceList stewards)`
`void`	`setTheName(String name)`
`void`	`setUsesDataFileDefinitions(ReferenceList uses_data_file_definitions)`

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.
  - host
```
protected Reference host
```
    The host property, displayed as 'Host' in the IGC UI.
    
    Will be a single Reference to a Host 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.
  - contains_amazon_s3_data_file_folders
```
protected ReferenceList contains_amazon_s3_data_file_folders
```
    The contains_amazon_s3_data_file_folders property, displayed as 'Contains Amazon S3 Data File Folders' in the IGC UI.
    
    Will be a ReferenceList of MainObject objects.
  - contains_amazon_s3_data_files
```
protected ReferenceList contains_amazon_s3_data_files
```
    The contains_amazon_s3_data_files property, displayed as 'Contains Amazon S3 Data Files' in the IGC UI.
    
    Will be a ReferenceList of AmazonS3DataFile objects.
  - uses_data_file_definitions
```
protected ReferenceList uses_data_file_definitions
```
    The uses_data_file_definitions property, displayed as 'Uses Data File Definitions' in the IGC UI.
    
    Will be a ReferenceList of DataFileDefinition objects.
  - location
```
protected String location
```
    The location property, displayed as 'Location' in the IGC UI.
  - source_creation_date
```
protected Date source_creation_date
```
    The source_creation_date property, displayed as 'Source Creation Date' in the IGC UI.
  - source_modification_date
```
protected Date source_modification_date
```
    The source_modification_date property, displayed as 'Source Modification Date' in the IGC UI.
  - data_connection
```
protected ReferenceList data_connection
```
    The data_connection property, displayed as 'Data Connection' in the IGC UI.
    
    Will be a ReferenceList of DataConnection 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
  - AmazonS3Bucket
```
public AmazonS3Bucket()
```
- 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
  - getHost
```
public Reference getHost()
```
    See Also:
    
    host
  - setHost
```
public void setHost(Reference host)
```
    See Also:
    
    host
  - 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
  - getContainsAmazonS3DataFileFolders
```
public ReferenceList getContainsAmazonS3DataFileFolders()
```
    See Also:
    
    contains_amazon_s3_data_file_folders
  - setContainsAmazonS3DataFileFolders
```
public void setContainsAmazonS3DataFileFolders(ReferenceList contains_amazon_s3_data_file_folders)
```
    See Also:
    
    contains_amazon_s3_data_file_folders
  - getContainsAmazonS3DataFiles
```
public ReferenceList getContainsAmazonS3DataFiles()
```
    See Also:
    
    contains_amazon_s3_data_files
  - setContainsAmazonS3DataFiles
```
public void setContainsAmazonS3DataFiles(ReferenceList contains_amazon_s3_data_files)
```
    See Also:
    
    contains_amazon_s3_data_files
  - getUsesDataFileDefinitions
```
public ReferenceList getUsesDataFileDefinitions()
```
    See Also:
    
    uses_data_file_definitions
  - setUsesDataFileDefinitions
```
public void setUsesDataFileDefinitions(ReferenceList uses_data_file_definitions)
```
    See Also:
    
    uses_data_file_definitions
  - getLocation
```
public String getLocation()
```
    See Also:
    
    location
  - setLocation
```
public void setLocation(String location)
```
    See Also:
    
    location
  - getSourceCreationDate
```
public Date getSourceCreationDate()
```
    See Also:
    
    source_creation_date
  - setSourceCreationDate
```
public void setSourceCreationDate(Date source_creation_date)
```
    See Also:
    
    source_creation_date
  - getSourceModificationDate
```
public Date getSourceModificationDate()
```
    See Also:
    
    source_modification_date
  - setSourceModificationDate
```
public void setSourceModificationDate(Date source_modification_date)
```
    See Also:
    
    source_modification_date
  - getDataConnection
```
public ReferenceList getDataConnection()
```
    See Also:
    
    data_connection
  - setDataConnection
```
public void setDataConnection(ReferenceList data_connection)
```
    See Also:
    
    data_connection
  - 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()
```
  - isAmazonS3Bucket
```
public static Boolean isAmazonS3Bucket(Object obj)
```

Class AmazonS3Bucket

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

host

labels

stewards

assigned_to_terms

implements_rules

governed_by_rules

contains_amazon_s3_data_file_folders

contains_amazon_s3_data_files

uses_data_file_definitions

location

source_creation_date

source_modification_date

data_connection

in_collections

created_by

created_on

modified_by

modified_on

Constructor Detail

AmazonS3Bucket

Method Detail

getIgcTypeId

getIgcTypeDisplayName

getTheName

setTheName

getShortDescription

setShortDescription

getLongDescription

setLongDescription

getHost

setHost

getLabels

setLabels

getStewards

setStewards

getAssignedToTerms

setAssignedToTerms

getImplementsRules

setImplementsRules

getGovernedByRules

setGovernedByRules

getContainsAmazonS3DataFileFolders

setContainsAmazonS3DataFileFolders

getContainsAmazonS3DataFiles

setContainsAmazonS3DataFiles

getUsesDataFileDefinitions

setUsesDataFileDefinitions

getLocation

setLocation

getSourceCreationDate

setSourceCreationDate

getSourceModificationDate

setSourceModificationDate

getDataConnection

setDataConnection

getInCollections

setInCollections

getCreatedBy

setCreatedBy

getCreatedOn

setCreatedOn

getModifiedBy

setModifiedBy

getModifiedOn

setModifiedOn

canBeCreated

includesModificationDetails

getNonRelationshipProperties