Class UpdateEntityDetails

Properties used in entity update operations.

Inheritance

object

UpdateEntityDetails

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 UpdateEntityDetails

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.

CustomPropertyMembers

Declaration

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

Property Value

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

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.

FolderKey

Declaration

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

Property Value

Type	Description
string	Key of the associated folder.

HarvestStatus

Declaration

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

Property Value

Type	Description
HarvestStatus?	Status of the object as updated by the harvest process. When an entity object is created, it's harvest status will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.

IsLogical

Declaration

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

Property Value

Type	Description
bool?	Property to indicate if the object is a physical materialized object or virtual. For example, View.

IsPartition

Declaration

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

Property Value

Type	Description
bool?	Property to indicate if the object is a sub object of a parent physical object.

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.

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 entities have required properties within the "default" category. To determine the set of required and optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it's properties, can be identified from this collection. Example: {"properties": { "default": { "key1": "value1"}}}

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 entities have required properties within the "default" category. To determine the set of required and optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it's properties, can be identified from this collection. 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

TimeExternal

Declaration

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

Property Value

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