DashboardSummary

class oci.dashboard_service.models.DashboardSummary(**kwargs)

Bases: object

Summary information about the dashboard.

Methods:

__init__(**kwargs)

Initializes a new DashboardSummary object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this DashboardSummary.

dashboard_group_id

[Required] Gets the dashboard_group_id of this DashboardSummary.

defined_tags

[Required] Gets the defined_tags of this DashboardSummary.

description

[Required] Gets the description of this DashboardSummary.

display_name

[Required] Gets the display_name of this DashboardSummary.

freeform_tags

[Required] Gets the freeform_tags of this DashboardSummary.

id

[Required] Gets the id of this DashboardSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this DashboardSummary.

system_tags

Gets the system_tags of this DashboardSummary.

time_created

[Required] Gets the time_created of this DashboardSummary.

time_updated

Gets the time_updated of this DashboardSummary.

__init__(**kwargs)

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

  • dashboard_group_id (str) – The value to assign to the dashboard_group_id property of this DashboardSummary.

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DashboardSummary.

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

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

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

property compartment_id

[Required] Gets the compartment_id of this DashboardSummary. The OCID of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.

Returns

The compartment_id of this DashboardSummary.

Return type

str

property dashboard_group_id

[Required] Gets the dashboard_group_id of this DashboardSummary. The OCID of the dashboard group that the dashboard belongs to.

Returns

The dashboard_group_id of this DashboardSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

[Required] Gets the description of this DashboardSummary. A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/’”&

Returns

The description of this DashboardSummary.

Return type

str

property display_name

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

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this DashboardSummary. The OCID of the dashboard resource.

Returns

The id of this DashboardSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DashboardSummary. The current state of the Dashboard.

Returns

The lifecycle_state of this DashboardSummary.

Return type

str

property system_tags

Gets the system_tags of this DashboardSummary. 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 DashboardSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this DashboardSummary. The date and time the dashboard was created, in the format defined by RFC3339.

Example: `2016-08-25T21:10:29.600Z

Returns

The time_created of this DashboardSummary.

Return type

datetime

property time_updated

Gets the time_updated of this DashboardSummary. The date and time the dashboard was updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_updated of this DashboardSummary.

Return type

datetime