ManagementDashboard

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

Bases: object

Properties of a dashboard, including dashboard ID.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ManagementDashboard.

compartment_id

[Required] Gets the compartment_id of this ManagementDashboard.

created_by

[Required] Gets the created_by of this ManagementDashboard.

dashboard_id

[Required] Gets the dashboard_id of this ManagementDashboard.

data_config

[Required] Gets the data_config of this ManagementDashboard.

defined_tags

Gets the defined_tags of this ManagementDashboard.

description

[Required] Gets the description of this ManagementDashboard.

display_name

[Required] Gets the display_name of this ManagementDashboard.

drilldown_config

Gets the drilldown_config of this ManagementDashboard.

features_config

Gets the features_config of this ManagementDashboard.

freeform_tags

Gets the freeform_tags of this ManagementDashboard.

id

[Required] Gets the id of this ManagementDashboard.

is_favorite

[Required] Gets the is_favorite of this ManagementDashboard.

is_oob_dashboard

[Required] Gets the is_oob_dashboard of this ManagementDashboard.

is_show_description

[Required] Gets the is_show_description of this ManagementDashboard.

is_show_in_home

[Required] Gets the is_show_in_home of this ManagementDashboard.

lifecycle_state

[Required] Gets the lifecycle_state of this ManagementDashboard.

metadata_version

[Required] Gets the metadata_version of this ManagementDashboard.

nls

[Required] Gets the nls of this ManagementDashboard.

parameters_config

Gets the parameters_config of this ManagementDashboard.

provider_id

[Required] Gets the provider_id of this ManagementDashboard.

provider_name

[Required] Gets the provider_name of this ManagementDashboard.

provider_version

[Required] Gets the provider_version of this ManagementDashboard.

saved_searches

[Required] Gets the saved_searches of this ManagementDashboard.

screen_image

[Required] Gets the screen_image of this ManagementDashboard.

system_tags

Gets the system_tags of this ManagementDashboard.

tiles

[Required] Gets the tiles of this ManagementDashboard.

time_created

[Required] Gets the time_created of this ManagementDashboard.

time_updated

[Required] Gets the time_updated of this ManagementDashboard.

type

[Required] Gets the type of this ManagementDashboard.

ui_config

[Required] Gets the ui_config of this ManagementDashboard.

updated_by

[Required] Gets the updated_by of this ManagementDashboard.

Methods:

__init__(**kwargs)

Initializes a new ManagementDashboard object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ManagementDashboard. This constant has a value of “ACTIVE”

__init__(**kwargs)

Initializes a new ManagementDashboard 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 ManagementDashboard.

  • id (str) – The value to assign to the id property of this ManagementDashboard.

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

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

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

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

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

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

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

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

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

  • created_by (str) – The value to assign to the created_by property of this ManagementDashboard.

  • time_created (datetime) – The value to assign to the time_created property of this ManagementDashboard.

  • updated_by (str) – The value to assign to the updated_by property of this ManagementDashboard.

  • time_updated (datetime) – The value to assign to the time_updated property of this ManagementDashboard.

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

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

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

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

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

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

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

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

  • saved_searches (list[oci.management_dashboard.models.ManagementSavedSearch]) – The value to assign to the saved_searches property of this ManagementDashboard.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementDashboard. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

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

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

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

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

property compartment_id

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

Returns

The compartment_id of this ManagementDashboard.

Return type

str

property created_by

[Required] Gets the created_by of this ManagementDashboard. User who created the dashboard.

Returns

The created_by of this ManagementDashboard.

Return type

str

property dashboard_id

[Required] Gets the dashboard_id of this ManagementDashboard. ID of the dashboard. Same as id.

Returns

The dashboard_id of this ManagementDashboard.

Return type

str

property data_config

[Required] Gets the data_config of this ManagementDashboard. Array of JSON that contain data source options.

Returns

The data_config of this ManagementDashboard.

Return type

list[object]

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this ManagementDashboard.

Return type

str

property display_name

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

Returns

The display_name of this ManagementDashboard.

Return type

str

property drilldown_config

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

Returns

The drilldown_config of this ManagementDashboard.

Return type

list[object]

property features_config

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

Returns

The features_config of this ManagementDashboard.

Return type

object

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this ManagementDashboard. ID of the dashboard. Same as dashboardId.

Returns

The id of this ManagementDashboard.

Return type

str

property is_favorite

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

Returns

The is_favorite of this ManagementDashboard.

Return type

bool

property is_oob_dashboard

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

Return type

bool

property is_show_description

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

Returns

The is_show_description of this ManagementDashboard.

Return type

bool

property is_show_in_home

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

Returns

The is_show_in_home of this ManagementDashboard.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this ManagementDashboard. State of dashboard.

Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this ManagementDashboard.

Return type

str

property metadata_version

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

Return type

str

property nls

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

Returns

The nls of this ManagementDashboard.

Return type

object

property parameters_config

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

Returns

The parameters_config of this ManagementDashboard.

Return type

list[object]

property provider_id

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

Returns

The provider_id of this ManagementDashboard.

Return type

str

property provider_name

[Required] Gets the provider_name of this ManagementDashboard. Name of the service (for example, Logging Analytics) that owns the dashboard.

Returns

The provider_name of this ManagementDashboard.

Return type

str

property provider_version

[Required] Gets the provider_version of this ManagementDashboard. Version of the service that owns the dashboard.

Returns

The provider_version of this ManagementDashboard.

Return type

str

property saved_searches

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

Returns

The saved_searches of this ManagementDashboard.

Return type

list[oci.management_dashboard.models.ManagementSavedSearch]

property screen_image

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

Returns

The screen_image of this ManagementDashboard.

Return type

str

property system_tags

Gets the system_tags of this ManagementDashboard. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this ManagementDashboard.

Return type

dict(str, dict(str, object))

property tiles

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

Returns

The tiles of this ManagementDashboard.

Return type

list[oci.management_dashboard.models.ManagementDashboardTileDetails]

property time_created

[Required] Gets the time_created of this ManagementDashboard. Date and time the dashboard was created.

Returns

The time_created of this ManagementDashboard.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this ManagementDashboard. Date and time the dashboard was updated.

Returns

The time_updated of this ManagementDashboard.

Return type

datetime

property type

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

Returns

The type of this ManagementDashboard.

Return type

str

property ui_config

[Required] Gets the ui_config of this ManagementDashboard. JSON that contains user interface options.

Returns

The ui_config of this ManagementDashboard.

Return type

object

property updated_by

[Required] Gets the updated_by of this ManagementDashboard. User who updated the dashboard.

Returns

The updated_by of this ManagementDashboard.

Return type

str