Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateCustomPropertyDetails

Properties used in custom property create operations.

Properties

Optional allowedValues

allowedValues: Array<string>

Allowed values for the custom property if any

Optional dataType

dataType: model.CustomPropertyDataType

The data type of the custom property

Optional description

description: undefined | string

Detailed description of the custom property.

displayName

displayName: string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional isEditable

isEditable: undefined | false | true

If this field is a editable field

Optional isEventEnabled

isEventEnabled: undefined | false | true

If an OCI Event will be emitted when the custom property is modified.

Optional isFilterable

isFilterable: undefined | false | true

If this field allows to filter or create facets from UI

Optional isHidden

isHidden: undefined | false | true

If this field is a hidden field

Optional isHiddenInSearch

isHiddenInSearch: undefined | false | true

If this field is allowed to pop in search results

Optional isMultiValued

isMultiValued: undefined | false | true

If this field allows multiple values to be set

Optional isShownInList

isShownInList: undefined | false | true

If this field is displayed in a list view of applicable objects.

Optional isSortable

isSortable: undefined | false | true

If this field allows to sort from UI

Optional properties

properties: undefined | object

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

Functions

getDeserializedJsonObj

getJsonObj