java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.datacatalog.model.Entity

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Entity
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Data entity details.
A representation of data with a set of attributes, normally representing a single business entity. Synonymous with ‘table’ or ‘view’ in a database, or a single logical file structure that one or many files may match.
Note: Objects should always be created or deserialized using the Entity.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Entity.Builder, which maintain a set of all explicitly set fields called Entity.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Entity.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
Entity(String key, String displayName, String businessName, String description, Date timeCreated, Date timeUpdated, String createdById, String updatedById, LifecycleState lifecycleState, String lifecycleDetails, String externalKey, String patternKey, String realizedExpression, Date timeExternal, Date timeHarvested, List<ObjectRelationship> objectRelationships, Date timeStatusUpdated, Boolean isLogical, Boolean isPartition, String dataAssetKey, String folderKey, String folderName, String path, HarvestStatus harvestStatus, String lastJobKey, String typeKey, String uri, String objectStorageUrl, List<CustomPropertyGetUsage> customPropertyMembers, Map<String,Map<String,String>> properties)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Entity.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getBusinessName()`	Optional user friendly business name of the data entity.
`String`	`getCreatedById()`	OCID of the user who created this object in the data catalog.
`List<CustomPropertyGetUsage>`	`getCustomPropertyMembers()`	The list of customized properties along with the values for this object
`String`	`getDataAssetKey()`	Unique key of the parent data asset.
`String`	`getDescription()`	Detailed description of a data entity.
`String`	`getDisplayName()`	A user-friendly display name.
`String`	`getExternalKey()`	Unique external key of this object in the source system.
`String`	`getFolderKey()`	Key of the associated folder.
`String`	`getFolderName()`	Name of the associated folder.
`HarvestStatus`	`getHarvestStatus()`	Status of the object as updated by the harvest process.
`Boolean`	`getIsLogical()`	Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
`Boolean`	`getIsPartition()`	Property that identifies if an object is a sub object of a physical or materialized parent object.
`String`	`getKey()`	Unique data entity key that is immutable.
`String`	`getLastJobKey()`	Key of the last harvest process to update this object.
`String`	`getLifecycleDetails()`	A message describing the current state in more detail.
`LifecycleState`	`getLifecycleState()`	The current state of the data entity.
`List<ObjectRelationship>`	`getObjectRelationships()`	List of objects and their relationships to this entity.
`String`	`getObjectStorageUrl()`	URL of the data entity in the object store.
`String`	`getPath()`	Full path of the data entity.
`String`	`getPatternKey()`	Key of the associated pattern if this is a logical entity.
`Map<String,Map<String,String>>`	`getProperties()`	A map of maps that contains the properties which are specific to the entity type.
`String`	`getRealizedExpression()`	The expression realized after resolving qualifiers .
`Date`	`getTimeCreated()`	The date and time the data entity was created, in the format defined by RFC3339.
`Date`	`getTimeExternal()`	Last modified timestamp of this object in the external system.
`Date`	`getTimeHarvested()`	The date and time the entity was harvested, in the format defined by RFC3339.
`Date`	`getTimeStatusUpdated()`	Time that the data entities status was last updated.
`Date`	`getTimeUpdated()`	The last time that any change was made to the data entity.
`String`	`getTypeKey()`	The type of data entity object.
`String`	`getUpdatedById()`	OCID of the user who updated this object in the data catalog.
`String`	`getUri()`	URI to the data entity instance in the API.
`int`	`hashCode()`
`Entity.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

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

- Constructor Detail
  - Entity
```
@Deprecated
@ConstructorProperties({"key","displayName","businessName","description","timeCreated","timeUpdated","createdById","updatedById","lifecycleState","lifecycleDetails","externalKey","patternKey","realizedExpression","timeExternal","timeHarvested","objectRelationships","timeStatusUpdated","isLogical","isPartition","dataAssetKey","folderKey","folderName","path","harvestStatus","lastJobKey","typeKey","uri","objectStorageUrl","customPropertyMembers","properties"})
public Entity(String key,
              String displayName,
              String businessName,
              String description,
              Date timeCreated,
              Date timeUpdated,
              String createdById,
              String updatedById,
              LifecycleState lifecycleState,
              String lifecycleDetails,
              String externalKey,
              String patternKey,
              String realizedExpression,
              Date timeExternal,
              Date timeHarvested,
              List<ObjectRelationship> objectRelationships,
              Date timeStatusUpdated,
              Boolean isLogical,
              Boolean isPartition,
              String dataAssetKey,
              String folderKey,
              String folderName,
              String path,
              HarvestStatus harvestStatus,
              String lastJobKey,
              String typeKey,
              String uri,
              String objectStorageUrl,
              List<CustomPropertyGetUsage> customPropertyMembers,
              Map<String,Map<String,String>> properties)
```
    Deprecated.
- Method Detail
  - builder
```
public static Entity.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public Entity.Builder toBuilder()
```
  - getKey
```
public String getKey()
```
    Unique data entity key that is immutable.
    
    Returns:
    
    the value
  - getDisplayName
```
public String getDisplayName()
```
    A user-friendly display name.
    Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Returns:
    
    the value
  - getBusinessName
```
public String getBusinessName()
```
    Optional user friendly business name of the data entity.
    If set, this supplements the harvested display name of the object.
    
    Returns:
    
    the value
  - getDescription
```
public String getDescription()
```
    Detailed description of a data entity.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The date and time the data entity was created, in the format defined by RFC3339.
    Example: 2019-03-25T21:10:29.600Z
    
    Returns:
    
    the value
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    The last time that any change was made to the data entity.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getCreatedById
```
public String getCreatedById()
```
    OCID of the user who created this object in the data catalog.
    
    Returns:
    
    the value
  - getUpdatedById
```
public String getUpdatedById()
```
    OCID of the user who updated this object in the data catalog.
    
    Returns:
    
    the value
  - getLifecycleState
```
public LifecycleState getLifecycleState()
```
    The current state of the data entity.
    
    Returns:
    
    the value
  - getLifecycleDetails
```
public String getLifecycleDetails()
```
    A message describing the current state in more detail.
    An object not in ACTIVE state may have functional limitations, see service documentation for details.
    
    Returns:
    
    the value
  - getExternalKey
```
public String getExternalKey()
```
    Unique external key of this object in the source system.
    
    Returns:
    
    the value
  - getPatternKey
```
public String getPatternKey()
```
    Key of the associated pattern if this is a logical entity.
    
    Returns:
    
    the value
  - getRealizedExpression
```
public String getRealizedExpression()
```
    The expression realized after resolving qualifiers .
    Used in deriving this logical entity
    
    Returns:
    
    the value
  - getTimeExternal
```
public Date getTimeExternal()
```
    Last modified timestamp of this object in the external system.
    
    Returns:
    
    the value
  - getTimeHarvested
```
public Date getTimeHarvested()
```
    The date and time the entity was harvested, in the format defined by RFC3339.
    
    Returns:
    
    the value
  - getObjectRelationships
```
public List<ObjectRelationship> getObjectRelationships()
```
    List of objects and their relationships to this entity.
    
    Returns:
    
    the value
  - getTimeStatusUpdated
```
public Date getTimeStatusUpdated()
```
    Time that the data entities status was last updated.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getIsLogical
```
public Boolean getIsLogical()
```
    Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
    
    Returns:
    
    the value
  - getIsPartition
```
public Boolean getIsPartition()
```
    Property that identifies if an object is a sub object of a physical or materialized parent object.
    
    Returns:
    
    the value
  - getDataAssetKey
```
public String getDataAssetKey()
```
    Unique key of the parent data asset.
    
    Returns:
    
    the value
  - getFolderKey
```
public String getFolderKey()
```
    Key of the associated folder.
    
    Returns:
    
    the value
  - getFolderName
```
public String getFolderName()
```
    Name of the associated folder.
    This name is harvested from the source data asset when the parent folder for the entiy is harvested.
    
    Returns:
    
    the value
  - getPath
```
public String getPath()
```
    Full path of the data entity.
    
    Returns:
    
    the value
  - getHarvestStatus
```
public HarvestStatus getHarvestStatus()
```
    Status of the object as updated by the harvest process.
    
    Returns:
    
    the value
  - getLastJobKey
```
public String getLastJobKey()
```
    Key of the last harvest process to update this object.
    
    Returns:
    
    the value
  - getTypeKey
```
public String getTypeKey()
```
    The type of data entity object.
    Type key’s can be found via the ‘/types’ endpoint.
    
    Returns:
    
    the value
  - getUri
```
public String getUri()
```
    URI to the data entity instance in the API.
    
    Returns:
    
    the value
  - getObjectStorageUrl
```
public String getObjectStorageUrl()
```
    URL of the data entity in the object store.
    
    Returns:
    
    the value
  - getCustomPropertyMembers
```
public List<CustomPropertyGetUsage> getCustomPropertyMembers()
```
    The list of customized properties along with the values for this object
    
    Returns:
    
    the value
  - getProperties
```
public Map<String,Map<String,String>> getProperties()
```
    A map of maps that contains the properties which are specific to the entity type.
    Each entity type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data entities have required properties within the “default” category. Example: {“properties”: { “default”: { “key1”: “value1”}}}
    
    Returns:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class Entity

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Method Detail

builder

toBuilder

getKey

getDisplayName

getBusinessName

getDescription

getTimeCreated

getTimeUpdated

getCreatedById

getUpdatedById

getLifecycleState

getLifecycleDetails

getExternalKey

getPatternKey

getRealizedExpression

getTimeExternal

getTimeHarvested

getObjectRelationships

getTimeStatusUpdated

getIsLogical

getIsPartition

getDataAssetKey

getFolderKey

getFolderName

getPath

getHarvestStatus

getLastJobKey

getTypeKey

getUri

getObjectStorageUrl

getCustomPropertyMembers

getProperties

toString

toString

equals

hashCode