Class CustomProperty

Custom Property Definition

Inheritance

object

CustomProperty

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 CustomProperty

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

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the custom property.

DataType

Declaration

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

Property Value

Type	Description
CustomPropertyDataType?	Data type of the custom property

Description

Declaration

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

Property Value

Type	Description
string	Description for the custom property

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Display name of the custom property

Events

Declaration

[JsonProperty(PropertyName = "events")]
public List<EventConfig> Events { get; set; }

Property Value

Type	Description
List<EventConfig>	Event configuration for this custom property, against the desired subset of object types to which the property applies.

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

IsListType

Declaration

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

Property Value

Type	Description
bool?	Is this property allowed to have list of values

IsMultiValued

Declaration

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

Property Value

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

IsServiceDefined

Declaration

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

Property Value

Type	Description
bool?	If this field is defined by service or by a user

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

Key

Declaration

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

Property Value

Type	Description
string	Unique data asset key that is immutable.

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the custom property.

NamespaceName

Declaration

[JsonProperty(PropertyName = "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	Namespace name of the custom property

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 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. Example: {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}

Scope

Declaration

[JsonProperty(PropertyName = "scope")]
public List<CustomPropertyTypeUsage> Scope { get; set; }

Property Value

Type	Description
List<CustomPropertyTypeUsage>	The set of object types to which the custom property applies.

TimeCreated

Declaration

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

Property Value

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

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

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who last modified the custom property.

UsageCount

Declaration

[JsonProperty(PropertyName = "usageCount")]
public int? UsageCount { get; set; }

Property Value

Type	Description
int?	Total number of first class objects using this custom property