Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Property

Taxonomy metadata aka Property .

Properties

compartmentId

compartmentId: string

Tenancy OCID

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

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

Example: {@code My new resource}

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

lifecycleState

lifecycleState: LifecycleState

The current state of the Property.

resourceRegion

resourceRegion: string

Associated region

Optional scope

scope: model.Scope

The scope of the property

Optional selection

selection: model.Selection

Text selection of the category

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time this resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Optional type

type: Type

The type of the property.

Optional valueType

valueType: model.ValueType

Format of the value

Optional values

values: Array<string>

Values of the property (must be a single value if selection = 'single choice')

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Property): object

getJsonObj