DashboardGroup¶
- class oci.dashboard_service.models.DashboardGroup(**kwargs)¶
Bases:
objectThe base schema for a dashboard group.
Attributes:
A constant which can be used with the lifecycle_state property of a DashboardGroup.
A constant which can be used with the lifecycle_state property of a DashboardGroup.
A constant which can be used with the lifecycle_state property of a DashboardGroup.
A constant which can be used with the lifecycle_state property of a DashboardGroup.
A constant which can be used with the lifecycle_state property of a DashboardGroup.
A constant which can be used with the lifecycle_state property of a DashboardGroup.
[Required] Gets the compartment_id of this DashboardGroup.
[Required] Gets the defined_tags of this DashboardGroup.
[Required] Gets the description of this DashboardGroup.
[Required] Gets the display_name of this DashboardGroup.
[Required] Gets the freeform_tags of this DashboardGroup.
[Required] Gets the id of this DashboardGroup.
[Required] Gets the lifecycle_state of this DashboardGroup.
Gets the system_tags of this DashboardGroup.
[Required] Gets the time_created of this DashboardGroup.
[Required] Gets the time_updated of this DashboardGroup.
Methods:
__init__(**kwargs)Initializes a new DashboardGroup object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a DashboardGroup. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new DashboardGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this DashboardGroup.
display_name (str) – The value to assign to the display_name property of this DashboardGroup.
description (str) – The value to assign to the description property of this DashboardGroup.
compartment_id (str) – The value to assign to the compartment_id property of this DashboardGroup.
time_created (datetime) – The value to assign to the time_created property of this DashboardGroup.
time_updated (datetime) – The value to assign to the time_updated property of this DashboardGroup.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DashboardGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘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 DashboardGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DashboardGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DashboardGroup.
- property compartment_id¶
[Required] Gets the compartment_id of this DashboardGroup. The OCID of the compartment containing the dashboard group.
- Returns
The compartment_id of this DashboardGroup.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this DashboardGroup. 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 DashboardGroup.
- Return type
dict(str, dict(str, object))
- property description¶
[Required] Gets the description of this DashboardGroup. A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/’”&
- Returns
The description of this DashboardGroup.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DashboardGroup. A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/’”&
- Returns
The display_name of this DashboardGroup.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this DashboardGroup. 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 DashboardGroup.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DashboardGroup. The OCID of the dashboard group.
- Returns
The id of this DashboardGroup.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DashboardGroup. The current state of the DashboardGroup resource.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DashboardGroup.
- Return type
str
- property system_tags¶
Gets the system_tags of this DashboardGroup. 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 DashboardGroup.
- Return type
dict(str, dict(str, object))