ManagementDashboardSummary

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

Bases: object

Summary of the properties of a dashboard.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a ManagementDashboardSummary.
compartment_id [Required] Gets the compartment_id of this ManagementDashboardSummary.
created_by [Required] Gets the created_by of this ManagementDashboardSummary.
dashboard_id [Required] Gets the dashboard_id of this ManagementDashboardSummary.
defined_tags [Required] Gets the defined_tags of this ManagementDashboardSummary.
description [Required] Gets the description of this ManagementDashboardSummary.
display_name [Required] Gets the display_name of this ManagementDashboardSummary.
freeform_tags [Required] Gets the freeform_tags of this ManagementDashboardSummary.
is_oob_dashboard [Required] Gets the is_oob_dashboard of this ManagementDashboardSummary.
lifecycle_state [Required] Gets the lifecycle_state of this ManagementDashboardSummary.
metadata_version [Required] Gets the metadata_version of this ManagementDashboardSummary.
nls [Required] Gets the nls of this ManagementDashboardSummary.
screen_image [Required] Gets the screen_image of this ManagementDashboardSummary.
time_created [Required] Gets the time_created of this ManagementDashboardSummary.
time_updated [Required] Gets the time_updated of this ManagementDashboardSummary.
type [Required] Gets the type of this ManagementDashboardSummary.
updated_by [Required] Gets the updated_by of this ManagementDashboardSummary.

Methods

__init__(**kwargs) Initializes a new ManagementDashboardSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

__init__(**kwargs)

Initializes a new ManagementDashboardSummary 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 ManagementDashboardSummary.
  • display_name (str) – The value to assign to the display_name property of this ManagementDashboardSummary.
  • description (str) – The value to assign to the description property of this ManagementDashboardSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this ManagementDashboardSummary.
  • is_oob_dashboard (bool) – The value to assign to the is_oob_dashboard property of this ManagementDashboardSummary.
  • created_by (str) – The value to assign to the created_by property of this ManagementDashboardSummary.
  • time_created (datetime) – The value to assign to the time_created property of this ManagementDashboardSummary.
  • updated_by (str) – The value to assign to the updated_by property of this ManagementDashboardSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this ManagementDashboardSummary.
  • metadata_version (str) – The value to assign to the metadata_version property of this ManagementDashboardSummary.
  • screen_image (str) – The value to assign to the screen_image property of this ManagementDashboardSummary.
  • nls (object) – The value to assign to the nls property of this ManagementDashboardSummary.
  • type (str) – The value to assign to the type property of this ManagementDashboardSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementDashboardSummary. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementDashboardSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementDashboardSummary.
compartment_id

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

Returns:The compartment_id of this ManagementDashboardSummary.
Return type:str
created_by

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

Returns:The created_by of this ManagementDashboardSummary.
Return type:str
dashboard_id

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

Returns:The dashboard_id of this ManagementDashboardSummary.
Return type:str
defined_tags

[Required] Gets the defined_tags of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
Return type:dict(str, dict(str, object))
description

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

Returns:The description of this ManagementDashboardSummary.
Return type:str
display_name

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

Returns:The display_name of this ManagementDashboardSummary.
Return type:str
freeform_tags

[Required] Gets the freeform_tags of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
Return type:dict(str, str)
is_oob_dashboard

[Required] Gets the is_oob_dashboard of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this ManagementDashboardSummary. Current lifecycle state of the 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 ManagementDashboardSummary.
Return type:str
metadata_version

[Required] Gets the metadata_version of this ManagementDashboardSummary. Version of the metadata.

Returns:The metadata_version of this ManagementDashboardSummary.
Return type:str
nls

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

Returns:The nls of this ManagementDashboardSummary.
Return type:object
screen_image

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

Returns:The screen_image of this ManagementDashboardSummary.
Return type:str
time_created

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

Returns:The time_created of this ManagementDashboardSummary.
Return type:datetime
time_updated

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

Returns:The time_updated of this ManagementDashboardSummary.
Return type:datetime
type

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

Returns:The type of this ManagementDashboardSummary.
Return type:str
updated_by

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

Returns:The updated_by of this ManagementDashboardSummary.
Return type:str