Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CustomPropertySummary

Summary of a custom property

Properties

Optional allowedValues

allowedValues: Array<string>

Allowed values for the custom property if any

Optional createdById

createdById: undefined | string

OCID of the user who created the custom property.

Optional dataType

dataType: model.CustomPropertyDataType

Data type of the custom property

Optional description

description: undefined | string

Description of the custom property

Optional displayName

displayName: undefined | string

Display name of the custom property

Optional events

Event configuration for this custom property, against the desired subset of object types to which the property applies.

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 isServiceDefined

isServiceDefined: undefined | false | true

If this field is defined by service or by a user

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

key

key: string

Unique custom property key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the custom property.

Optional namespaceName

namespaceName: undefined | string

Namespace name of the custom property

Optional scope

Type or scope of the custom property belongs to. This will be an array of type id it will be belongs to

Optional timeCreated

timeCreated: Date

The date and time the custom property was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The last time that any change was made to the custom property. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who last modified the custom property.

Optional usageCount

usageCount: undefined | number

Total number of first class objects using this custom property Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj