Class CreateFolderDetails

Properties used in folder create operations.

Inheritance

object

CreateFolderDetails

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 CreateFolderDetails

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.

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

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[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.

Remarks

Required

HarvestStatus

Declaration

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

Property Value

Type	Description
HarvestStatus?	Folder harvesting status.

LastJobKey

Declaration

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

Property Value

Type	Description
string	The job key of the harvest process that updated the folder definition from the source system.

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

TimeExternal

Declaration

[Required(ErrorMessage = "TimeExternal is required.")]
[JsonProperty(PropertyName = "timeExternal")]
public DateTime? TimeExternal { get; set; }

Property Value

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

Remarks

Required

TypeKey

Declaration

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

Property Value

Type	Description
string	Type key of the object. Type keys can be found via the '/types' endpoint.