Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateManagementDashboardDetails

Properties of a dashboard. Dashboard ID must not be provided.

Properties

Optional compartmentId

compartmentId: undefined | string

OCID of the compartment in which the dashboard resides.

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

Optional description

description: undefined | string

Description of the dashboard.

Optional displayName

displayName: undefined | 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"}}

Optional isFavorite

isFavorite: undefined | false | true

Determines whether the dashboard is set as favorite.

Optional isOobDashboard

isOobDashboard: undefined | false | true

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.

Optional isShowDescription

isShowDescription: undefined | false | true

Determines whether the description of the dashboard is displayed.

Optional isShowInHome

isShowInHome: undefined | false | true

Determines whether the dashboard will be displayed in Dashboard Home.

Optional metadataVersion

metadataVersion: undefined | string

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

Optional nls

nls: any

JSON that contains internationalization options.

Optional parametersConfig

parametersConfig: Array<any>

Defines parameters for the dashboard.

Optional providerId

providerId: undefined | string

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

Optional providerName

providerName: undefined | string

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

Optional providerVersion

providerVersion: undefined | 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.

Optional screenImage

screenImage: undefined | string

Screen image of the dashboard.

Optional tiles

Array of dashboard tiles.

Optional type

type: undefined | string

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

Optional uiConfig

uiConfig: any

JSON that contains user interface options.

Functions

getDeserializedJsonObj

getJsonObj