ManagementDashboardForImportExportDetails¶

class oci.management_dashboard.models.ManagementDashboardForImportExportDetails(**kwargs)¶

Bases: object

Properties of a dashboard, including dashboard ID and saved searches, for import purposes.

Methods

__init__(**kwargs) Initializes a new ManagementDashboardForImportExportDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this ManagementDashboardForImportExportDetails.
`dashboard_id`	[Required] Gets the dashboard_id of this ManagementDashboardForImportExportDetails.
`data_config`	[Required] Gets the data_config of this ManagementDashboardForImportExportDetails.
`defined_tags`	Gets the defined_tags of this ManagementDashboardForImportExportDetails.
`description`	[Required] Gets the description of this ManagementDashboardForImportExportDetails.
`display_name`	[Required] Gets the display_name of this ManagementDashboardForImportExportDetails.
`drilldown_config`	Gets the drilldown_config of this ManagementDashboardForImportExportDetails.
`features_config`	Gets the features_config of this ManagementDashboardForImportExportDetails.
`freeform_tags`	Gets the freeform_tags of this ManagementDashboardForImportExportDetails.
`is_favorite`	[Required] Gets the is_favorite of this ManagementDashboardForImportExportDetails.
`is_oob_dashboard`	[Required] Gets the is_oob_dashboard of this ManagementDashboardForImportExportDetails.
`is_show_description`	[Required] Gets the is_show_description of this ManagementDashboardForImportExportDetails.
`is_show_in_home`	[Required] Gets the is_show_in_home of this ManagementDashboardForImportExportDetails.
`metadata_version`	[Required] Gets the metadata_version of this ManagementDashboardForImportExportDetails.
`nls`	[Required] Gets the nls of this ManagementDashboardForImportExportDetails.
`parameters_config`	Gets the parameters_config of this ManagementDashboardForImportExportDetails.
`provider_id`	[Required] Gets the provider_id of this ManagementDashboardForImportExportDetails.
`provider_name`	[Required] Gets the provider_name of this ManagementDashboardForImportExportDetails.
`provider_version`	[Required] Gets the provider_version of this ManagementDashboardForImportExportDetails.
`saved_searches`	[Required] Gets the saved_searches of this ManagementDashboardForImportExportDetails.
`screen_image`	[Required] Gets the screen_image of this ManagementDashboardForImportExportDetails.
`tiles`	[Required] Gets the tiles of this ManagementDashboardForImportExportDetails.
`type`	[Required] Gets the type of this ManagementDashboardForImportExportDetails.
`ui_config`	[Required] Gets the ui_config of this ManagementDashboardForImportExportDetails.

__init__(**kwargs)¶

Initializes a new ManagementDashboardForImportExportDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

dashboard_id (str) – The value to assign to the dashboard_id property of this ManagementDashboardForImportExportDetails.
provider_id (str) – The value to assign to the provider_id property of this ManagementDashboardForImportExportDetails.
provider_name (str) – The value to assign to the provider_name property of this ManagementDashboardForImportExportDetails.
provider_version (str) – The value to assign to the provider_version property of this ManagementDashboardForImportExportDetails.
tiles (list[oci.management_dashboard.models.ManagementDashboardTileDetails]) – The value to assign to the tiles property of this ManagementDashboardForImportExportDetails.
display_name (str) – The value to assign to the display_name property of this ManagementDashboardForImportExportDetails.
description (str) – The value to assign to the description property of this ManagementDashboardForImportExportDetails.
compartment_id (str) – The value to assign to the compartment_id property of this ManagementDashboardForImportExportDetails.
is_oob_dashboard (bool) – The value to assign to the is_oob_dashboard property of this ManagementDashboardForImportExportDetails.
is_show_in_home (bool) – The value to assign to the is_show_in_home property of this ManagementDashboardForImportExportDetails.
metadata_version (str) – The value to assign to the metadata_version property of this ManagementDashboardForImportExportDetails.
is_show_description (bool) – The value to assign to the is_show_description property of this ManagementDashboardForImportExportDetails.
screen_image (str) – The value to assign to the screen_image property of this ManagementDashboardForImportExportDetails.
nls (object) – The value to assign to the nls property of this ManagementDashboardForImportExportDetails.
ui_config (object) – The value to assign to the ui_config property of this ManagementDashboardForImportExportDetails.
data_config (list[object]) – The value to assign to the data_config property of this ManagementDashboardForImportExportDetails.
type (str) – The value to assign to the type property of this ManagementDashboardForImportExportDetails.
is_favorite (bool) – The value to assign to the is_favorite property of this ManagementDashboardForImportExportDetails.
saved_searches (list[oci.management_dashboard.models.ManagementSavedSearchForImportDetails]) – The value to assign to the saved_searches property of this ManagementDashboardForImportExportDetails.
parameters_config (list[object]) – The value to assign to the parameters_config property of this ManagementDashboardForImportExportDetails.
features_config (object) – The value to assign to the features_config property of this ManagementDashboardForImportExportDetails.
drilldown_config (list[object]) – The value to assign to the drilldown_config property of this ManagementDashboardForImportExportDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementDashboardForImportExportDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementDashboardForImportExportDetails.

compartment_id¶

[Required] Gets the compartment_id of this ManagementDashboardForImportExportDetails. OCID of the compartment in which the dashboard resides.

Returns:	The compartment_id of this ManagementDashboardForImportExportDetails.
Return type:	str

dashboard_id¶

[Required] Gets the dashboard_id of this ManagementDashboardForImportExportDetails. ID of the dashboard.

Returns:	The dashboard_id of this ManagementDashboardForImportExportDetails.
Return type:	str

data_config¶

[Required] Gets the data_config of this ManagementDashboardForImportExportDetails. It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

Returns:	The data_config of this ManagementDashboardForImportExportDetails.
Return type:	list[object]

defined_tags¶

Gets the defined_tags of this ManagementDashboardForImportExportDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ManagementDashboardForImportExportDetails.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this ManagementDashboardForImportExportDetails. Description of the dashboard.

Returns:	The description of this ManagementDashboardForImportExportDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this ManagementDashboardForImportExportDetails. Display name of the dashboard.

Returns:	The display_name of this ManagementDashboardForImportExportDetails.
Return type:	str

drilldown_config¶

Gets the drilldown_config of this ManagementDashboardForImportExportDetails. Drill-down configuration to define the destination of a drill-down action.

Returns:	The drilldown_config of this ManagementDashboardForImportExportDetails.
Return type:	list[object]

features_config¶

Gets the features_config of this ManagementDashboardForImportExportDetails. Contains configuration for enabling features.

Returns:	The features_config of this ManagementDashboardForImportExportDetails.
Return type:	object

freeform_tags¶

Gets the freeform_tags of this ManagementDashboardForImportExportDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ManagementDashboardForImportExportDetails.
Return type:	dict(str, str)

is_favorite¶

[Required] Gets the is_favorite of this ManagementDashboardForImportExportDetails. Determines whether the dashboard is set as favorite.

Returns:	The is_favorite of this ManagementDashboardForImportExportDetails.
Return type:	bool

is_oob_dashboard¶

[Required] Gets the is_oob_dashboard of this ManagementDashboardForImportExportDetails. 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.

Returns:	The is_oob_dashboard of this ManagementDashboardForImportExportDetails.
Return type:	bool

is_show_description¶

[Required] Gets the is_show_description of this ManagementDashboardForImportExportDetails. Determines whether the description of the dashboard is displayed.

Returns:	The is_show_description of this ManagementDashboardForImportExportDetails.
Return type:	bool

is_show_in_home¶

[Required] Gets the is_show_in_home of this ManagementDashboardForImportExportDetails. Determines whether the dashboard will be displayed in Dashboard Home.

Returns:	The is_show_in_home of this ManagementDashboardForImportExportDetails.
Return type:	bool

metadata_version¶

[Required] Gets the metadata_version of this ManagementDashboardForImportExportDetails. The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

Returns:	The metadata_version of this ManagementDashboardForImportExportDetails.
Return type:	str

nls¶

[Required] Gets the nls of this ManagementDashboardForImportExportDetails. JSON that contains internationalization options.

Returns:	The nls of this ManagementDashboardForImportExportDetails.
Return type:	object

parameters_config¶

Gets the parameters_config of this ManagementDashboardForImportExportDetails. Defines parameters for the dashboard.

Returns:	The parameters_config of this ManagementDashboardForImportExportDetails.
Return type:	list[object]

provider_id¶

[Required] Gets the provider_id of this ManagementDashboardForImportExportDetails. ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID.

Returns:	The provider_id of this ManagementDashboardForImportExportDetails.
Return type:	str

provider_name¶

[Required] Gets the provider_name of this ManagementDashboardForImportExportDetails. The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

Returns:	The provider_name of this ManagementDashboardForImportExportDetails.
Return type:	str

provider_version¶

[Required] Gets the provider_version of this ManagementDashboardForImportExportDetails. 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.

Returns:	The provider_version of this ManagementDashboardForImportExportDetails.
Return type:	str

saved_searches¶

[Required] Gets the saved_searches of this ManagementDashboardForImportExportDetails. Array of saved searches in the dashboard.

Returns:	The saved_searches of this ManagementDashboardForImportExportDetails.
Return type:	list[oci.management_dashboard.models.ManagementSavedSearchForImportDetails]

screen_image¶

[Required] Gets the screen_image of this ManagementDashboardForImportExportDetails. Screen image of the dashboard.

Returns:	The screen_image of this ManagementDashboardForImportExportDetails.
Return type:	str

tiles¶

[Required] Gets the tiles of this ManagementDashboardForImportExportDetails. Array of dashboard tiles.

Returns:	The tiles of this ManagementDashboardForImportExportDetails.
Return type:	list[oci.management_dashboard.models.ManagementDashboardTileDetails]

type¶

[Required] Gets the type of this ManagementDashboardForImportExportDetails. Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

Returns:	The type of this ManagementDashboardForImportExportDetails.
Return type:	str

ui_config¶

[Required] Gets the ui_config of this ManagementDashboardForImportExportDetails. It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

Returns:	The ui_config of this ManagementDashboardForImportExportDetails.
Return type:	object