Class FolderSummary

Summary of a 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

FolderSummary

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 FolderSummary

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.

DataAssetKey

Declaration

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

Property Value

Type	Description
string	The 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 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 from the source systems.

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

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?	State of the 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 key of the containing folder or null if there is no parent.

Path

Declaration

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

Property Value

Type	Description
string	Full path of the folder.

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.

TimeUpdated

Declaration

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

Property Value

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

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.

Uri

Declaration

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

Property Value

Type	Description
string	URI of the folder resource within the data catalog API.