Dashboard¶

class oci.dashboard_service.models.Dashboard(**kwargs)¶

Bases: object

The base schema for a dashboard. Derived schemas have configurations and widgets specific to the schemaVersion.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Dashboard.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Dashboard.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Dashboard.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Dashboard.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Dashboard.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Dashboard.
`SCHEMA_VERSION_V1`	A constant which can be used with the schema_version property of a Dashboard.
`compartment_id`	[Required] Gets the compartment_id of this Dashboard.
`dashboard_group_id`	[Required] Gets the dashboard_group_id of this Dashboard.
`defined_tags`	[Required] Gets the defined_tags of this Dashboard.
`description`	[Required] Gets the description of this Dashboard.
`display_name`	[Required] Gets the display_name of this Dashboard.
`freeform_tags`	[Required] Gets the freeform_tags of this Dashboard.
`id`	[Required] Gets the id of this Dashboard.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Dashboard.
`schema_version`	[Required] Gets the schema_version of this Dashboard.
`system_tags`	Gets the system_tags of this Dashboard.
`time_created`	[Required] Gets the time_created of this Dashboard.
`time_updated`	[Required] Gets the time_updated of this Dashboard.

Methods

`__init__`(**kwargs)	Initializes a new Dashboard object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Dashboard. This constant has a value of “UPDATING”

SCHEMA_VERSION_V1 = 'V1'¶: A constant which can be used with the schema_version property of a Dashboard. This constant has a value of “V1”

__init__(**kwargs)¶

Initializes a new Dashboard object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

V1Dashboard

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 Dashboard.
dashboard_group_id (str) – The value to assign to the dashboard_group_id property of this Dashboard.
display_name (str) – The value to assign to the display_name property of this Dashboard.
description (str) – The value to assign to the description property of this Dashboard.
compartment_id (str) – The value to assign to the compartment_id property of this Dashboard.
schema_version (str) – The value to assign to the schema_version property of this Dashboard. Allowed values for this property are: “V1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this Dashboard.
time_updated (datetime) – The value to assign to the time_updated property of this Dashboard.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Dashboard. 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 Dashboard.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Dashboard.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Dashboard.

compartment_id¶

[Required] Gets the compartment_id of this Dashboard. 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 Dashboard.
Return type:	str

dashboard_group_id¶

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

Returns:	The dashboard_group_id of this Dashboard.
Return type:	str

defined_tags¶

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

description¶

[Required] Gets the description of this Dashboard. 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 Dashboard.
Return type:	str

display_name¶

[Required] Gets the display_name of this Dashboard. 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 Dashboard.
Return type:	str

freeform_tags¶

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

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

Returns:	The id of this Dashboard.
Return type:	str

lifecycle_state¶

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

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 Dashboard.
Return type:	str

schema_version¶

[Required] Gets the schema_version of this Dashboard. The schema describing how to interpret the dashboard configuration and widgets.

Allowed values for this property are: “V1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The schema_version of this Dashboard.
Return type:	str

system_tags¶

Gets the system_tags of this Dashboard. 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 Dashboard.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Dashboard. 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 Dashboard.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this Dashboard. 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 Dashboard.
Return type:	datetime