BusinessObjectData (herd docs javadoc 0.38.0 API)

java.lang.Object
- org.finra.herd.sdk.model.BusinessObjectData

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T15:10:39.441-05:00")
public class BusinessObjectData
extends Object

The business object data

Constructor Summary

Constructors
Constructor and Description

BusinessObjectData()

Constructors
Constructor and Description
`BusinessObjectData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`List<Attribute>`	`getAttributes()` Collection of name-value pairs.
`List<BusinessObjectDataKey>`	`getBusinessObjectDataChildren()` A list of Business Object Data children that were creation from this data.
`List<BusinessObjectDataKey>`	`getBusinessObjectDataParents()` A list of Business Object Data parents (i.e.
`List<BusinessObjectDataStatusChangeEvent>`	`getBusinessObjectDataStatusHistory()` Lists all business object data status change events for this business object data
`String`	`getBusinessObjectDefinitionName()` The name of the Business Object Definition to which a Business Object Format is related
`String`	`getBusinessObjectFormatFileType()` A File Type known to the system that describes the file type of data stored under a Business Object Format
`String`	`getBusinessObjectFormatUsage()` The Usage of this Business Object Format - a string describing how this format is used.
`Integer`	`getBusinessObjectFormatVersion()` The Business Object Format Version for a previously registered Business Object Format
`Integer`	`getId()` The internal Id that uniquely references the newly created Business Object Data
`Boolean`	`getLatestVersion()` No longer in use A boolean flag that shows whether this instance of data is the latest or not.
`String`	`getNamespace()` The Namespace to which a Business Object Format is related
`String`	`getPartitionKey()` The Partition Key this Business Object Data is being registered with.
`String`	`getPartitionValue()` The Partition Value that this Business Object Data is associated with
`String`	`getStatus()` The status of the Business Object Data.
`List<StorageUnit>`	`getStorageUnits()` A container for the Storage Units associated with a Business Object Data
`List<String>`	`getSubPartitionValues()` A list of Sub-Partition values associated with this Business Object Data
`Integer`	`getVersion()` The numeric version of a Business Object Data.
`int`	`hashCode()`
`void`	`setAttributes(List<Attribute> attributes)`
`void`	`setBusinessObjectDataChildren(List<BusinessObjectDataKey> businessObjectDataChildren)`
`void`	`setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)`
`void`	`setBusinessObjectDataStatusHistory(List<BusinessObjectDataStatusChangeEvent> businessObjectDataStatusHistory)`
`void`	`setBusinessObjectDefinitionName(String businessObjectDefinitionName)`
`void`	`setBusinessObjectFormatFileType(String businessObjectFormatFileType)`
`void`	`setBusinessObjectFormatUsage(String businessObjectFormatUsage)`
`void`	`setBusinessObjectFormatVersion(Integer businessObjectFormatVersion)`
`void`	`setId(Integer id)`
`void`	`setLatestVersion(Boolean latestVersion)`
`void`	`setNamespace(String namespace)`
`void`	`setPartitionKey(String partitionKey)`
`void`	`setPartitionValue(String partitionValue)`
`void`	`setStatus(String status)`
`void`	`setStorageUnits(List<StorageUnit> storageUnits)`
`void`	`setSubPartitionValues(List<String> subPartitionValues)`
`void`	`setVersion(Integer version)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BusinessObjectData
```
public BusinessObjectData()
```
- Method Detail
  - getId
```
public Integer getId()
```
    The internal Id that uniquely references the newly created Business Object Data
  - setId
```
public void setId(Integer id)
```
  - getNamespace
```
public String getNamespace()
```
    The Namespace to which a Business Object Format is related
  - setNamespace
```
public void setNamespace(String namespace)
```
  - getBusinessObjectDefinitionName
```
public String getBusinessObjectDefinitionName()
```
    The name of the Business Object Definition to which a Business Object Format is related
  - setBusinessObjectDefinitionName
```
public void setBusinessObjectDefinitionName(String businessObjectDefinitionName)
```
  - getBusinessObjectFormatUsage
```
public String getBusinessObjectFormatUsage()
```
    The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business\n Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object\n Definitions
  - setBusinessObjectFormatUsage
```
public void setBusinessObjectFormatUsage(String businessObjectFormatUsage)
```
  - getBusinessObjectFormatFileType
```
public String getBusinessObjectFormatFileType()
```
    A File Type known to the system that describes the file type of data stored under a Business Object Format
  - setBusinessObjectFormatFileType
```
public void setBusinessObjectFormatFileType(String businessObjectFormatFileType)
```
  - getBusinessObjectFormatVersion
```
public Integer getBusinessObjectFormatVersion()
```
    The Business Object Format Version for a previously registered Business Object Format
  - setBusinessObjectFormatVersion
```
public void setBusinessObjectFormatVersion(Integer businessObjectFormatVersion)
```
  - getPartitionKey
```
public String getPartitionKey()
```
    The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business\n Object Format
  - setPartitionKey
```
public void setPartitionKey(String partitionKey)
```
  - getPartitionValue
```
public String getPartitionValue()
```
    The Partition Value that this Business Object Data is associated with
  - setPartitionValue
```
public void setPartitionValue(String partitionValue)
```
  - getSubPartitionValues
```
public List<String> getSubPartitionValues()
```
    A list of Sub-Partition values associated with this Business Object Data
  - setSubPartitionValues
```
public void setSubPartitionValues(List<String> subPartitionValues)
```
  - getVersion
```
public Integer getVersion()
```
    The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous\n version + 1
  - setVersion
```
public void setVersion(Integer version)
```
  - getLatestVersion
```
public Boolean getLatestVersion()
```
    *No longer in use* A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is\n registered, any previous versions will no longer be the latest
  - setLatestVersion
```
public void setLatestVersion(Boolean latestVersion)
```
  - getStatus
```
public String getStatus()
```
    The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID,\n ARCHIVED, EXPIRED, or DELETED
  - setStatus
```
public void setStatus(String status)
```
  - getStorageUnits
```
public List<StorageUnit> getStorageUnits()
```
    A container for the Storage Units associated with a Business Object Data
  - setStorageUnits
```
public void setStorageUnits(List<StorageUnit> storageUnits)
```
  - getAttributes
```
public List<Attribute> getAttributes()
```
    Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom\n user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the\n Business Object Format
  - setAttributes
```
public void setAttributes(List<Attribute> attributes)
```
  - getBusinessObjectDataParents
```
public List<BusinessObjectDataKey> getBusinessObjectDataParents()
```
    A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for\n data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.
  - setBusinessObjectDataParents
```
public void setBusinessObjectDataParents(List<BusinessObjectDataKey> businessObjectDataParents)
```
  - getBusinessObjectDataChildren
```
public List<BusinessObjectDataKey> getBusinessObjectDataChildren()
```
    A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists\n of the key data that uniquely defines a reference to a single Business Object Data.
  - setBusinessObjectDataChildren
```
public void setBusinessObjectDataChildren(List<BusinessObjectDataKey> businessObjectDataChildren)
```
  - getBusinessObjectDataStatusHistory
```
public List<BusinessObjectDataStatusChangeEvent> getBusinessObjectDataStatusHistory()
```
    Lists all business object data status change events for this business object data
  - setBusinessObjectDataStatusHistory
```
public void setBusinessObjectDataStatusHistory(List<BusinessObjectDataStatusChangeEvent> businessObjectDataStatusHistory)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BusinessObjectData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BusinessObjectData

Method Detail

getId

setId

getNamespace

setNamespace

getBusinessObjectDefinitionName

setBusinessObjectDefinitionName

getBusinessObjectFormatUsage

setBusinessObjectFormatUsage

getBusinessObjectFormatFileType

setBusinessObjectFormatFileType

getBusinessObjectFormatVersion

setBusinessObjectFormatVersion

getPartitionKey

setPartitionKey

getPartitionValue

setPartitionValue

getSubPartitionValues

setSubPartitionValues

getVersion

setVersion

getLatestVersion

setLatestVersion

getStatus

setStatus

getStorageUnits

setStorageUnits

getAttributes

setAttributes

getBusinessObjectDataParents

setBusinessObjectDataParents

getBusinessObjectDataChildren

setBusinessObjectDataChildren

getBusinessObjectDataStatusHistory

setBusinessObjectDataStatusHistory

equals

hashCode

toString