Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateManagementDashboardDetails

Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards.

Properties

compartmentId

compartmentId: string

OCID of the compartment in which the dashboard resides.

Optional dashboardId

dashboardId: undefined | string

ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.

dataConfig

dataConfig: Array<any>

Array of JSON that contain data source options.

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

description

description: string

Description of the dashboard.

displayName

displayName: string

Display name of the dashboard.

Optional drilldownConfig

drilldownConfig: Array<any>

Drill-down configuration to define the destination of a drill-down action.

Optional featuresConfig

featuresConfig: any

Contains configuration for enabling features.

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

isFavorite

isFavorite: boolean

Determines whether the dashboard is set as favorite.

isOobDashboard

isOobDashboard: boolean

Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

isShowDescription

isShowDescription: boolean

Determines whether the description of the dashboard is displayed.

isShowInHome

isShowInHome: boolean

Determines whether the dashboard will be displayed in Dashboard Home.

metadataVersion

metadataVersion: string

The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

nls

nls: any

JSON that contains internationalization options.

Optional parametersConfig

parametersConfig: Array<any>

Defines parameters for the dashboard.

providerId

providerId: string

ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

providerName

providerName: string

The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

providerVersion

providerVersion: string

The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

screenImage

screenImage: string

Screen image of the dashboard.

tiles

Array of dashboard tiles.

type

type: string

Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

uiConfig

uiConfig: any

JSON that contains user interface options.

Functions

getDeserializedJsonObj

getJsonObj