/** * ManagementDashboard API * API for the Management Dashboard micro-service. Use this API for dashboard and saved search metadata preservation and to perform tasks such as creating a dashboard, creating a saved search, and obtaining a list of dashboards and saved searches in a compartment. * OpenAPI spec version: 20200901 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards. */ export interface CreateManagementDashboardDetails { /** * ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards. */ "dashboardId"?: string; /** * ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. */ "providerId": string; /** * The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. */ "providerName": 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. */ "providerVersion": string; /** * Array of dashboard tiles. */ "tiles": Array; /** * Display name of the dashboard. */ "displayName": string; /** * Description of the dashboard. */ "description": string; /** * OCID of the compartment in which the dashboard resides. */ "compartmentId": string; /** * 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. */ "isOobDashboard": boolean; /** * Determines whether the dashboard will be displayed in Dashboard Home. */ "isShowInHome": boolean; /** * The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. */ "metadataVersion": string; /** * Determines whether the description of the dashboard is displayed. */ "isShowDescription": boolean; /** * Screen image of the dashboard. */ "screenImage": string; /** * JSON that contains internationalization options. */ "nls": any; /** * JSON that contains user interface options. */ "uiConfig": any; /** * Array of JSON that contain data source options. */ "dataConfig": Array; /** * Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. */ "type": string; /** * Determines whether the dashboard is set as favorite. */ "isFavorite": boolean; /** * Defines parameters for the dashboard. */ "parametersConfig"?: Array; /** * Contains configuration for enabling features. */ "featuresConfig"?: any; /** * Drill-down configuration to define the destination of a drill-down action. */ "drilldownConfig"?: Array; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. * Example: {@code {\"bar-key\": \"value\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. * Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; } export declare namespace CreateManagementDashboardDetails { function getJsonObj(obj: CreateManagementDashboardDetails): object; function getDeserializedJsonObj(obj: CreateManagementDashboardDetails): object; }