Class Folder

A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset. This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.

Inheritance

object

Folder

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 Folder

Properties

BusinessName

Declaration

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

Property Value

Type	Description
string	Optional user friendly business name of the folder. 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 the folder.

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	The key of the associated data asset.

Description

Declaration

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

Property Value

Type	Description
string	Detailed description of a folder.

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.

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.

Key

Declaration

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

Property Value

Type	Description
string	Unique folder key that is immutable.

Remarks

Required

LastJobKey

Declaration

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

Property Value

Type	Description
string	The key of the last harvest process to update the metadata of 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 folder.

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 folder.

ObjectStorageUrl

Declaration

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

Property Value

Type	Description
string	URL of the folder in the object store.

ParentFolderKey

Declaration

[JsonProperty(PropertyName = "parentFolderKey")]
public string ParentFolderKey { get; set; }

Property Value

Type	Description
string	The unique key of the containing folder or null if there is no parent folder.

Path

Declaration

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

Property Value

Type	Description
string	Full path of the folder.

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 folder type. Each folder 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 folders have required properties within the "default" category. Example: {"properties": { "default": { "key1": "value1"}}}

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the folder 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 folder was harvested, in the format defined by RFC3339.

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 folder. An RFC3339 formatted datetime string.

TypeKey

Declaration

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

Property Value

Type	Description
string	The type of folder object. Type keys 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 modified the folder.

Uri

Declaration

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

Property Value

Type	Description
string	URI to the folder instance in the API.