CreateManagementDashboardDetails¶
-
class
oci.management_dashboard.models.
CreateManagementDashboardDetails
(**kwargs)¶ Bases:
object
Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards.
Methods
__init__
(**kwargs)Initializes a new CreateManagementDashboardDetails object with values from keyword arguments. Attributes
compartment_id
[Required] Gets the compartment_id of this CreateManagementDashboardDetails. dashboard_id
Gets the dashboard_id of this CreateManagementDashboardDetails. data_config
[Required] Gets the data_config of this CreateManagementDashboardDetails. defined_tags
Gets the defined_tags of this CreateManagementDashboardDetails. description
[Required] Gets the description of this CreateManagementDashboardDetails. display_name
[Required] Gets the display_name of this CreateManagementDashboardDetails. drilldown_config
Gets the drilldown_config of this CreateManagementDashboardDetails. freeform_tags
Gets the freeform_tags of this CreateManagementDashboardDetails. is_favorite
[Required] Gets the is_favorite of this CreateManagementDashboardDetails. is_oob_dashboard
[Required] Gets the is_oob_dashboard of this CreateManagementDashboardDetails. is_show_description
[Required] Gets the is_show_description of this CreateManagementDashboardDetails. is_show_in_home
[Required] Gets the is_show_in_home of this CreateManagementDashboardDetails. metadata_version
[Required] Gets the metadata_version of this CreateManagementDashboardDetails. nls
[Required] Gets the nls of this CreateManagementDashboardDetails. parameters_config
Gets the parameters_config of this CreateManagementDashboardDetails. provider_id
[Required] Gets the provider_id of this CreateManagementDashboardDetails. provider_name
[Required] Gets the provider_name of this CreateManagementDashboardDetails. provider_version
[Required] Gets the provider_version of this CreateManagementDashboardDetails. screen_image
[Required] Gets the screen_image of this CreateManagementDashboardDetails. tiles
[Required] Gets the tiles of this CreateManagementDashboardDetails. type
[Required] Gets the type of this CreateManagementDashboardDetails. ui_config
[Required] Gets the ui_config of this CreateManagementDashboardDetails. -
__init__
(**kwargs)¶ Initializes a new CreateManagementDashboardDetails 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 CreateManagementDashboardDetails.
- provider_id (str) – The value to assign to the provider_id property of this CreateManagementDashboardDetails.
- provider_name (str) – The value to assign to the provider_name property of this CreateManagementDashboardDetails.
- provider_version (str) – The value to assign to the provider_version property of this CreateManagementDashboardDetails.
- tiles (list[oci.management_dashboard.models.ManagementDashboardTileDetails]) – The value to assign to the tiles property of this CreateManagementDashboardDetails.
- display_name (str) – The value to assign to the display_name property of this CreateManagementDashboardDetails.
- description (str) – The value to assign to the description property of this CreateManagementDashboardDetails.
- compartment_id (str) – The value to assign to the compartment_id property of this CreateManagementDashboardDetails.
- is_oob_dashboard (bool) – The value to assign to the is_oob_dashboard property of this CreateManagementDashboardDetails.
- is_show_in_home (bool) – The value to assign to the is_show_in_home property of this CreateManagementDashboardDetails.
- metadata_version (str) – The value to assign to the metadata_version property of this CreateManagementDashboardDetails.
- is_show_description (bool) – The value to assign to the is_show_description property of this CreateManagementDashboardDetails.
- screen_image (str) – The value to assign to the screen_image property of this CreateManagementDashboardDetails.
- nls (object) – The value to assign to the nls property of this CreateManagementDashboardDetails.
- ui_config (object) – The value to assign to the ui_config property of this CreateManagementDashboardDetails.
- data_config (list[object]) – The value to assign to the data_config property of this CreateManagementDashboardDetails.
- type (str) – The value to assign to the type property of this CreateManagementDashboardDetails.
- is_favorite (bool) – The value to assign to the is_favorite property of this CreateManagementDashboardDetails.
- parameters_config (list[object]) – The value to assign to the parameters_config property of this CreateManagementDashboardDetails.
- drilldown_config (list[object]) – The value to assign to the drilldown_config property of this CreateManagementDashboardDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateManagementDashboardDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateManagementDashboardDetails.
-
compartment_id
¶ [Required] Gets the compartment_id of this CreateManagementDashboardDetails. OCID of the compartment in which the dashboard resides.
Returns: The compartment_id of this CreateManagementDashboardDetails. Return type: str
-
dashboard_id
¶ Gets the dashboard_id of this CreateManagementDashboardDetails. ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
Returns: The dashboard_id of this CreateManagementDashboardDetails. Return type: str
-
data_config
¶ [Required] Gets the data_config of this CreateManagementDashboardDetails. Array of JSON that contain data source options.
Returns: The data_config of this CreateManagementDashboardDetails. Return type: list[object]
Gets the defined_tags of this CreateManagementDashboardDetails. 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 CreateManagementDashboardDetails. Return type: dict(str, dict(str, object))
-
description
¶ [Required] Gets the description of this CreateManagementDashboardDetails. Description of the dashboard.
Returns: The description of this CreateManagementDashboardDetails. Return type: str
-
display_name
¶ [Required] Gets the display_name of this CreateManagementDashboardDetails. Display name of the dashboard.
Returns: The display_name of this CreateManagementDashboardDetails. Return type: str
-
drilldown_config
¶ Gets the drilldown_config of this CreateManagementDashboardDetails. Drill-down configuration to define the destination of a drill-down action.
Returns: The drilldown_config of this CreateManagementDashboardDetails. Return type: list[object]
Gets the freeform_tags of this CreateManagementDashboardDetails. 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 CreateManagementDashboardDetails. Return type: dict(str, str)
-
is_favorite
¶ [Required] Gets the is_favorite of this CreateManagementDashboardDetails. Determines whether the dashboard is set as favorite.
Returns: The is_favorite of this CreateManagementDashboardDetails. Return type: bool
-
is_oob_dashboard
¶ [Required] Gets the is_oob_dashboard of this CreateManagementDashboardDetails. 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 CreateManagementDashboardDetails. Return type: bool
-
is_show_description
¶ [Required] Gets the is_show_description of this CreateManagementDashboardDetails. Determines whether the description of the dashboard is displayed.
Returns: The is_show_description of this CreateManagementDashboardDetails. Return type: bool
-
is_show_in_home
¶ [Required] Gets the is_show_in_home of this CreateManagementDashboardDetails. Determines whether the dashboard will be displayed in Dashboard Home.
Returns: The is_show_in_home of this CreateManagementDashboardDetails. Return type: bool
-
metadata_version
¶ [Required] Gets the metadata_version of this CreateManagementDashboardDetails. Version of the metadata.
Returns: The metadata_version of this CreateManagementDashboardDetails. Return type: str
-
nls
¶ [Required] Gets the nls of this CreateManagementDashboardDetails. JSON that contains internationalization options.
Returns: The nls of this CreateManagementDashboardDetails. Return type: object
-
parameters_config
¶ Gets the parameters_config of this CreateManagementDashboardDetails. Defines parameters for the dashboard.
Returns: The parameters_config of this CreateManagementDashboardDetails. Return type: list[object]
-
provider_id
¶ [Required] Gets the provider_id of this CreateManagementDashboardDetails. ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
Returns: The provider_id of this CreateManagementDashboardDetails. Return type: str
-
provider_name
¶ [Required] Gets the provider_name of this CreateManagementDashboardDetails. Name of the service (for example, Logging Analytics) that owns the dashboard.
Returns: The provider_name of this CreateManagementDashboardDetails. Return type: str
-
provider_version
¶ [Required] Gets the provider_version of this CreateManagementDashboardDetails. Version of the service that owns the dashboard.
Returns: The provider_version of this CreateManagementDashboardDetails. Return type: str
-
screen_image
¶ [Required] Gets the screen_image of this CreateManagementDashboardDetails. Screen image of the dashboard.
Returns: The screen_image of this CreateManagementDashboardDetails. Return type: str
-
tiles
¶ [Required] Gets the tiles of this CreateManagementDashboardDetails. Array of dashboard tiles.
Returns: The tiles of this CreateManagementDashboardDetails. Return type: list[oci.management_dashboard.models.ManagementDashboardTileDetails]
-
type
¶ [Required] Gets the type of this CreateManagementDashboardDetails. Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Returns: The type of this CreateManagementDashboardDetails. Return type: str
-
ui_config
¶ [Required] Gets the ui_config of this CreateManagementDashboardDetails. JSON that contains user interface options.
Returns: The ui_config of this CreateManagementDashboardDetails. Return type: object
-