Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace V1Dashboard

A version 1 dashboard. The interpretation of the {@code config} and {@code widgets} fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the {@code config} and {@code widget} fields JSON text representation cannot exceed 200 KB.

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.

Optional config

config: any

The dashboard configuration. For example, the layout and widget placement.

dashboardGroupId

dashboardGroupId: string

The OCID of the dashboard group that the dashboard belongs to.

definedTags

definedTags: object

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

Type declaration

  • [key: string]: object
    • [key: string]: any

description

description: string

A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'"&\

displayName

displayName: string

A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\

freeformTags

freeformTags: 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"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the dashboard resource.

lifecycleState

lifecycleState: LifecycleState

The current state of the dashboard.

Const schemaVersion

schemaVersion: string = "V1"

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The date and time the dashboard was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

timeUpdated

timeUpdated: Date

The date and time the dashboard was updated, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

widgets

widgets: Array<any>

The visualization building blocks of the dashboard.

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Dashboard): object

getJsonObj