UpdateManagementDashboardDetails

class oci.management_dashboard.models.UpdateManagementDashboardDetails(**kwargs)

Bases: object

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

Methods:

__init__(**kwargs)

Initializes a new UpdateManagementDashboardDetails object with values from keyword arguments.

Attributes:

compartment_id

Gets the compartment_id of this UpdateManagementDashboardDetails.

data_config

Gets the data_config of this UpdateManagementDashboardDetails.

defined_tags

Gets the defined_tags of this UpdateManagementDashboardDetails.

description

Gets the description of this UpdateManagementDashboardDetails.

display_name

Gets the display_name of this UpdateManagementDashboardDetails.

drilldown_config

Gets the drilldown_config of this UpdateManagementDashboardDetails.

features_config

Gets the features_config of this UpdateManagementDashboardDetails.

freeform_tags

Gets the freeform_tags of this UpdateManagementDashboardDetails.

is_favorite

Gets the is_favorite of this UpdateManagementDashboardDetails.

is_oob_dashboard

Gets the is_oob_dashboard of this UpdateManagementDashboardDetails.

is_show_description

Gets the is_show_description of this UpdateManagementDashboardDetails.

is_show_in_home

Gets the is_show_in_home of this UpdateManagementDashboardDetails.

metadata_version

Gets the metadata_version of this UpdateManagementDashboardDetails.

nls

Gets the nls of this UpdateManagementDashboardDetails.

parameters_config

Gets the parameters_config of this UpdateManagementDashboardDetails.

provider_id

Gets the provider_id of this UpdateManagementDashboardDetails.

provider_name

Gets the provider_name of this UpdateManagementDashboardDetails.

provider_version

Gets the provider_version of this UpdateManagementDashboardDetails.

screen_image

Gets the screen_image of this UpdateManagementDashboardDetails.

tiles

Gets the tiles of this UpdateManagementDashboardDetails.

type

Gets the type of this UpdateManagementDashboardDetails.

ui_config

Gets the ui_config of this UpdateManagementDashboardDetails.

__init__(**kwargs)

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

Parameters
  • provider_id (str) – The value to assign to the provider_id property of this UpdateManagementDashboardDetails.

  • provider_name (str) – The value to assign to the provider_name property of this UpdateManagementDashboardDetails.

  • provider_version (str) – The value to assign to the provider_version property of this UpdateManagementDashboardDetails.

  • tiles (list[oci.management_dashboard.models.ManagementDashboardTileDetails]) – The value to assign to the tiles property of this UpdateManagementDashboardDetails.

  • display_name (str) – The value to assign to the display_name property of this UpdateManagementDashboardDetails.

  • description (str) – The value to assign to the description property of this UpdateManagementDashboardDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this UpdateManagementDashboardDetails.

  • is_oob_dashboard (bool) – The value to assign to the is_oob_dashboard property of this UpdateManagementDashboardDetails.

  • is_show_in_home (bool) – The value to assign to the is_show_in_home property of this UpdateManagementDashboardDetails.

  • metadata_version (str) – The value to assign to the metadata_version property of this UpdateManagementDashboardDetails.

  • is_show_description (bool) – The value to assign to the is_show_description property of this UpdateManagementDashboardDetails.

  • screen_image (str) – The value to assign to the screen_image property of this UpdateManagementDashboardDetails.

  • nls (object) – The value to assign to the nls property of this UpdateManagementDashboardDetails.

  • ui_config (object) – The value to assign to the ui_config property of this UpdateManagementDashboardDetails.

  • data_config (list[object]) – The value to assign to the data_config property of this UpdateManagementDashboardDetails.

  • type (str) – The value to assign to the type property of this UpdateManagementDashboardDetails.

  • is_favorite (bool) – The value to assign to the is_favorite property of this UpdateManagementDashboardDetails.

  • parameters_config (list[object]) – The value to assign to the parameters_config property of this UpdateManagementDashboardDetails.

  • features_config (object) – The value to assign to the features_config property of this UpdateManagementDashboardDetails.

  • drilldown_config (list[object]) – The value to assign to the drilldown_config property of this UpdateManagementDashboardDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateManagementDashboardDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateManagementDashboardDetails.

property compartment_id

Gets the compartment_id of this UpdateManagementDashboardDetails. OCID of the compartment in which the dashboard resides.

Returns

The compartment_id of this UpdateManagementDashboardDetails.

Return type

str

property data_config

Gets the data_config of this UpdateManagementDashboardDetails. Array of JSON that contain data source options.

Returns

The data_config of this UpdateManagementDashboardDetails.

Return type

list[object]

property defined_tags

Gets the defined_tags of this UpdateManagementDashboardDetails. 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 UpdateManagementDashboardDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this UpdateManagementDashboardDetails. Description of the dashboard.

Returns

The description of this UpdateManagementDashboardDetails.

Return type

str

property display_name

Gets the display_name of this UpdateManagementDashboardDetails. Display name of the dashboard.

Returns

The display_name of this UpdateManagementDashboardDetails.

Return type

str

property drilldown_config

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

Returns

The drilldown_config of this UpdateManagementDashboardDetails.

Return type

list[object]

property features_config

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

Returns

The features_config of this UpdateManagementDashboardDetails.

Return type

object

property freeform_tags

Gets the freeform_tags of this UpdateManagementDashboardDetails. 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 UpdateManagementDashboardDetails.

Return type

dict(str, str)

property is_favorite

Gets the is_favorite of this UpdateManagementDashboardDetails. Determines whether the dashboard is set as favorite.

Returns

The is_favorite of this UpdateManagementDashboardDetails.

Return type

bool

property is_oob_dashboard

Gets the is_oob_dashboard of this UpdateManagementDashboardDetails. 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 UpdateManagementDashboardDetails.

Return type

bool

property is_show_description

Gets the is_show_description of this UpdateManagementDashboardDetails. Determines whether the description of the dashboard is displayed.

Returns

The is_show_description of this UpdateManagementDashboardDetails.

Return type

bool

property is_show_in_home

Gets the is_show_in_home of this UpdateManagementDashboardDetails. Determines whether the dashboard will be displayed in Dashboard Home.

Returns

The is_show_in_home of this UpdateManagementDashboardDetails.

Return type

bool

property metadata_version

Gets the metadata_version of this UpdateManagementDashboardDetails. 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 UpdateManagementDashboardDetails.

Return type

str

property nls

Gets the nls of this UpdateManagementDashboardDetails. JSON that contains internationalization options.

Returns

The nls of this UpdateManagementDashboardDetails.

Return type

object

property parameters_config

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

Returns

The parameters_config of this UpdateManagementDashboardDetails.

Return type

list[object]

property provider_id

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

Returns

The provider_id of this UpdateManagementDashboardDetails.

Return type

str

property provider_name

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

Returns

The provider_name of this UpdateManagementDashboardDetails.

Return type

str

property provider_version

Gets the provider_version of this UpdateManagementDashboardDetails. 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 UpdateManagementDashboardDetails.

Return type

str

property screen_image

Gets the screen_image of this UpdateManagementDashboardDetails. Screen image of the dashboard.

Returns

The screen_image of this UpdateManagementDashboardDetails.

Return type

str

property tiles

Gets the tiles of this UpdateManagementDashboardDetails. Array of dashboard tiles.

Returns

The tiles of this UpdateManagementDashboardDetails.

Return type

list[oci.management_dashboard.models.ManagementDashboardTileDetails]

property type

Gets the type of this UpdateManagementDashboardDetails. Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

Returns

The type of this UpdateManagementDashboardDetails.

Return type

str

property ui_config

Gets the ui_config of this UpdateManagementDashboardDetails. JSON that contains user interface options.

Returns

The ui_config of this UpdateManagementDashboardDetails.

Return type

object