Class Entity

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.

Inheritance

object

Entity

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class Entity

Properties

BusinessName

Declaration

[JsonProperty(PropertyName = "businessName")]
public string BusinessName { get; set; }

Property Value

Type	Description
string	Optional user friendly business name of the data entity. If set, this supplements the harvested display name of the object.

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created this object in the data catalog.

CustomPropertyMembers

Declaration

[JsonProperty(PropertyName = "customPropertyMembers")]
public List<CustomPropertyGetUsage> CustomPropertyMembers { get; set; }

Property Value

Type	Description
List<CustomPropertyGetUsage>	The list of customized properties along with the values for this object

DataAssetKey

Declaration

[JsonProperty(PropertyName = "dataAssetKey")]
public string DataAssetKey { get; set; }

Property Value

Type	Description
string	Unique key of the parent data asset.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Detailed description of a data entity.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExternalKey

Declaration

[JsonProperty(PropertyName = "externalKey")]
public string ExternalKey { get; set; }

Property Value

Type	Description
string	Unique external key of this object in the source system.

FolderKey

Declaration

[JsonProperty(PropertyName = "folderKey")]
public string FolderKey { get; set; }

Property Value

Type	Description
string	Key of the associated folder.

FolderName

Declaration

[JsonProperty(PropertyName = "folderName")]
public string FolderName { get; set; }

Property Value

Type	Description
string	Name of the associated folder. This name is harvested from the source data asset when the parent folder for the entiy is harvested.

HarvestStatus

Declaration

[JsonProperty(PropertyName = "harvestStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HarvestStatus? HarvestStatus { get; set; }

Property Value

Type	Description
HarvestStatus?	Status of the object as updated by the harvest process.

IsLogical

Declaration

[JsonProperty(PropertyName = "isLogical")]
public bool? IsLogical { get; set; }

Property Value

Type	Description
bool?	Property that identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

IsPartition

Declaration

[JsonProperty(PropertyName = "isPartition")]
public bool? IsPartition { get; set; }

Property Value

Type	Description
bool?	Property that identifies if an object is a sub object of a physical or materialized parent object.

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique data entity key that is immutable.

Remarks

Required

LastJobKey

Declaration

[JsonProperty(PropertyName = "lastJobKey")]
public string LastJobKey { get; set; }

Property Value

Type	Description
string	Key of the last harvest process to update this object.

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail. An object not in ACTIVE state may have functional limitations, see service documentation for details.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the data entity.

ObjectRelationships

Declaration

[JsonProperty(PropertyName = "objectRelationships")]
public List<ObjectRelationship> ObjectRelationships { get; set; }

Property Value

Type	Description
List<ObjectRelationship>	List of objects and their relationships to this entity.

ObjectStorageUrl

Declaration

[JsonProperty(PropertyName = "objectStorageUrl")]
public string ObjectStorageUrl { get; set; }

Property Value

Type	Description
string	URL of the data entity in the object store.

Path

Declaration

[JsonProperty(PropertyName = "path")]
public string Path { get; set; }

Property Value

Type	Description
string	Full path of the data entity.

PatternKey

Declaration

[JsonProperty(PropertyName = "patternKey")]
public string PatternKey { get; set; }

Property Value

Type	Description
string	Key of the associated pattern if this is a logical entity.

Properties

Declaration

[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }

Property Value

Type

Description

Dictionary<string, Dictionary<string, string>>

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"}}}

RealizedExpression

Declaration

[JsonProperty(PropertyName = "realizedExpression")]
public string RealizedExpression { get; set; }

Property Value

Type	Description
string	The expression realized after resolving qualifiers . Used in deriving this logical entity

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the data entity was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeExternal

Declaration

[JsonProperty(PropertyName = "timeExternal")]
public DateTime? TimeExternal { get; set; }

Property Value

Type	Description
DateTime?	Last modified timestamp of this object in the external system.

TimeHarvested

Declaration

[JsonProperty(PropertyName = "timeHarvested")]
public DateTime? TimeHarvested { get; set; }

Property Value

Type	Description
DateTime?	The date and time the entity was harvested, in the format defined by RFC3339.

TimeStatusUpdated

Declaration

[JsonProperty(PropertyName = "timeStatusUpdated")]
public DateTime? TimeStatusUpdated { get; set; }

Property Value

Type	Description
DateTime?	Time that the data entities status was last updated. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The last time that any change was made to the data entity. An RFC3339 formatted datetime string.

TypeKey

Declaration

[JsonProperty(PropertyName = "typeKey")]
public string TypeKey { get; set; }

Property Value

Type	Description
string	The type of data entity object. Type key's can be found via the '/types' endpoint.

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who updated this object in the data catalog.

Uri

Declaration

[JsonProperty(PropertyName = "uri")]
public string Uri { get; set; }

Property Value

Type	Description
string	URI to the data entity instance in the API.