@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class EntitySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of an data entity. 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 EntitySummary.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 EntitySummary.Builder, which maintain a
set of all explicitly set fields called EntitySummary.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
EntitySummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
EntitySummary(String key,
String displayName,
String businessName,
String description,
Boolean isLogical,
Boolean isPartition,
String dataAssetKey,
String folderKey,
String folderName,
String externalKey,
String patternKey,
String typeKey,
String realizedExpression,
String path,
Date timeCreated,
Date timeUpdated,
String updatedById,
String uri,
String objectStorageUrl,
LifecycleState lifecycleState,
String lifecycleDetails,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static EntitySummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getBusinessName()
Optional user friendly business name of the data entity.
|
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.
|
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 |
getLifecycleDetails()
A message describing the current state in more detail.
|
LifecycleState |
getLifecycleState()
State of the data 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 |
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() |
EntitySummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","displayName","businessName","description","isLogical","isPartition","dataAssetKey","folderKey","folderName","externalKey","patternKey","typeKey","realizedExpression","path","timeCreated","timeUpdated","updatedById","uri","objectStorageUrl","lifecycleState","lifecycleDetails","properties"}) public EntitySummary(String key, String displayName, String businessName, String description, Boolean isLogical, Boolean isPartition, String dataAssetKey, String folderKey, String folderName, String externalKey, String patternKey, String typeKey, String realizedExpression, String path, Date timeCreated, Date timeUpdated, String updatedById, String uri, String objectStorageUrl, LifecycleState lifecycleState, String lifecycleDetails, Map<String,Map<String,String>> properties)
public static EntitySummary.Builder builder()
Create a new builder.
public EntitySummary.Builder toBuilder()
public String getKey()
Unique data entity key that is immutable.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getBusinessName()
Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.
public String getDescription()
Detailed description of a data entity.
public Boolean getIsLogical()
Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.
public Boolean getIsPartition()
Property that identifies if an object is a sub object of a physical or materialized parent object.
public String getDataAssetKey()
Unique key of the parent data asset.
public String getFolderKey()
Key of the associated folder.
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.
public String getExternalKey()
Unique external key of this object in the source system.
public String getPatternKey()
Key of the associated pattern if this is a logical entity.
public String getTypeKey()
The type of data entity object. Type keys can be found via the ‘/types’ endpoint.
public String getRealizedExpression()
The expression realized after resolving qualifiers . Used in deriving this logical entity
public String getPath()
Full path of the data entity.
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
public Date getTimeUpdated()
The last time that any change was made to the data entity. An RFC3339 formatted datetime string.
public String getUpdatedById()
OCID of the user who updated this object in the data catalog.
public String getUri()
URI to the data entity instance in the API.
public String getObjectStorageUrl()
URL of the data entity in the object store.
public LifecycleState getLifecycleState()
State of the data entity.
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.
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"}}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.