Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ManagementDashboardSummary

Summary of the properties of a dashboard.

Properties

compartmentId

compartmentId: string

OCID of the compartment in which the dashboard resides.

createdBy

createdBy: string

User who created the dashboard.

dashboardId

dashboardId: string

ID of the dashboard. Same as id.

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

Description of the dashboard.

displayName

displayName: string

Display name of the dashboard.

Optional featuresConfig

featuresConfig: any

Contains configuration for enabling features.

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

ID of the dashboard. Same as dashboardId.

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.

lifecycleState

lifecycleState: LifecycleStates

Current lifecycle state of the dashboard.

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.

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.

timeCreated

timeCreated: Date

Date and time the dashboard was created.

timeUpdated

timeUpdated: Date

Date and time the dashboard was updated.

type

type: string

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

updatedBy

updatedBy: string

User who updated the dashboard.

Functions

getDeserializedJsonObj

getJsonObj