ManagementDashboardSummary¶
- class oci.management_dashboard.models.ManagementDashboardSummary(**kwargs)¶
Bases:
objectSummary of the properties of a dashboard.
Attributes:
A constant which can be used with the lifecycle_state property of a ManagementDashboardSummary.
[Required] Gets the compartment_id of this ManagementDashboardSummary.
[Required] Gets the created_by of this ManagementDashboardSummary.
[Required] Gets the dashboard_id of this ManagementDashboardSummary.
[Required] Gets the defined_tags of this ManagementDashboardSummary.
[Required] Gets the description of this ManagementDashboardSummary.
[Required] Gets the display_name of this ManagementDashboardSummary.
Gets the features_config of this ManagementDashboardSummary.
[Required] Gets the freeform_tags of this ManagementDashboardSummary.
[Required] Gets the id of this ManagementDashboardSummary.
[Required] Gets the is_oob_dashboard of this ManagementDashboardSummary.
[Required] Gets the lifecycle_state of this ManagementDashboardSummary.
[Required] Gets the metadata_version of this ManagementDashboardSummary.
[Required] Gets the nls of this ManagementDashboardSummary.
[Required] Gets the provider_id of this ManagementDashboardSummary.
[Required] Gets the provider_name of this ManagementDashboardSummary.
[Required] Gets the provider_version of this ManagementDashboardSummary.
[Required] Gets the screen_image of this ManagementDashboardSummary.
Gets the system_tags of this ManagementDashboardSummary.
[Required] Gets the time_created of this ManagementDashboardSummary.
[Required] Gets the time_updated of this ManagementDashboardSummary.
[Required] Gets the type of this ManagementDashboardSummary.
[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.
id (str) – The value to assign to the 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.
provider_id (str) – The value to assign to the provider_id property of this ManagementDashboardSummary.
provider_name (str) – The value to assign to the provider_name property of this ManagementDashboardSummary.
provider_version (str) – The value to assign to the provider_version 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.
features_config (object) – The value to assign to the features_config 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.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ManagementDashboardSummary.
- property 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
- property 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
- property dashboard_id¶
[Required] Gets the dashboard_id of this ManagementDashboardSummary. ID of the dashboard. Same as id.
- Returns
The dashboard_id of this ManagementDashboardSummary.
- Return type
str
- property 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))
- property description¶
[Required] Gets the description of this ManagementDashboardSummary. Description of the dashboard.
- Returns
The description of this ManagementDashboardSummary.
- Return type
str
- property 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
- property features_config¶
Gets the features_config of this ManagementDashboardSummary. Contains configuration for enabling features.
- Returns
The features_config of this ManagementDashboardSummary.
- Return type
object
- property 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)
- property id¶
[Required] Gets the id of this ManagementDashboardSummary. ID of the dashboard. Same as dashboardId.
- Returns
The id of this ManagementDashboardSummary.
- Return type
str
- property 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
- property 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
- property metadata_version¶
[Required] Gets the metadata_version of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
- Return type
str
- property nls¶
[Required] Gets the nls of this ManagementDashboardSummary. JSON that contains internationalization options.
- Returns
The nls of this ManagementDashboardSummary.
- Return type
object
- property provider_id¶
[Required] Gets the provider_id of this ManagementDashboardSummary. ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
- Returns
The provider_id of this ManagementDashboardSummary.
- Return type
str
- property provider_name¶
[Required] Gets the provider_name of this ManagementDashboardSummary. The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
- Returns
The provider_name of this ManagementDashboardSummary.
- Return type
str
- property provider_version¶
[Required] Gets the provider_version of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
- Return type
str
- property 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
- property system_tags¶
Gets the system_tags of this ManagementDashboardSummary. 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 ManagementDashboardSummary.
- Return type
dict(str, dict(str, object))
- property 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
- property 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
- property 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
- property 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