Class CreateCustomPropertyDetails

Properties used in custom property create operations.

Inheritance

object

CreateCustomPropertyDetails

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 CreateCustomPropertyDetails

Properties

AllowedValues

Declaration

[JsonProperty(PropertyName = "allowedValues")]
public List<string> AllowedValues { get; set; }

Property Value

Type	Description
List<string>	Allowed values for the custom property if any

DataType

Declaration

[JsonProperty(PropertyName = "dataType")]
[JsonConverter(typeof(StringEnumConverter))]
public CustomPropertyDataType? DataType { get; set; }

Property Value

Type	Description
CustomPropertyDataType?	The data type of the custom property

Description

Declaration

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

Property Value

Type	Description
string	Detailed description of the custom property.

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

IsEditable

Declaration

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

Property Value

Type	Description
bool?	If this field is a editable field

IsEventEnabled

Declaration

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

Property Value

Type	Description
bool?	If an OCI Event will be emitted when the custom property is modified.

IsFilterable

Declaration

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

Property Value

Type	Description
bool?	If this field allows to filter or create facets from UI

IsHidden

Declaration

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

Property Value

Type	Description
bool?	If this field is a hidden field

IsHiddenInSearch

Declaration

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

Property Value

Type	Description
bool?	If this field is allowed to pop in search results

IsMultiValued

Declaration

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

Property Value

Type	Description
bool?	If this field allows multiple values to be set

IsShownInList

Declaration

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

Property Value

Type	Description
bool?	If this field is displayed in a list view of applicable objects.

IsSortable

Declaration

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

Property Value

Type	Description
bool?	If this field allows to sort from UI

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 data asset type. Each data asset 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 assets have required properties within the "default" category. To determine the set of optional and required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it's properties, can be identified from this collection. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

Type

Description

Dictionary<string, Dictionary<string, string>>

A map of maps that contains the properties which are specific to the data asset type. Each data asset 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 assets have required properties within the "default" category. To determine the set of optional and required properties for a data asset type, a query can be done on '/types?type=dataAsset' that returns a collection of all data asset types. The appropriate data asset type, which includes definitions of all of it's properties, can be identified from this collection. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}