CreateDashboardDetails¶

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

Bases: object

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

Methods

`__init__`(**kwargs)	Initializes a new CreateDashboardDetails 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.

Attributes

`dashboard_group_id`	[Required] Gets the dashboard_group_id of this CreateDashboardDetails.
`defined_tags`	Gets the defined_tags of this CreateDashboardDetails.
`description`	Gets the description of this CreateDashboardDetails.
`display_name`	Gets the display_name of this CreateDashboardDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDashboardDetails.
`schema_version`	[Required] Gets the schema_version of this CreateDashboardDetails.

__init__(**kwargs)¶

Initializes a new CreateDashboardDetails 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:

CreateV1DashboardDetails

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

dashboard_group_id (str) – The value to assign to the dashboard_group_id property of this CreateDashboardDetails.
display_name (str) – The value to assign to the display_name property of this CreateDashboardDetails.
description (str) – The value to assign to the description property of this CreateDashboardDetails.
schema_version (str) – The value to assign to the schema_version property of this CreateDashboardDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDashboardDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDashboardDetails.

dashboard_group_id¶

[Required] Gets the dashboard_group_id of this CreateDashboardDetails. The OCID of the dashboard group that the dashbaord is associated with.

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

defined_tags¶

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

description¶

Gets the description of this CreateDashboardDetails. 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 CreateDashboardDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateDashboardDetails. 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 CreateDashboardDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateDashboardDetails. 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 CreateDashboardDetails.
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.

schema_version¶

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

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