ManagementDashboardTileDetails¶
- class oci.management_dashboard.models.ManagementDashboardTileDetails(**kwargs)¶
Bases:
objectProperties of the dashboard tile representing a saved search. Tiles are laid out in a twelve column grid system with (0,0) at upper left corner.
Attributes:
A constant which can be used with the state property of a ManagementDashboardTileDetails.
A constant which can be used with the state property of a ManagementDashboardTileDetails.
A constant which can be used with the state property of a ManagementDashboardTileDetails.
[Required] Gets the column of this ManagementDashboardTileDetails.
[Required] Gets the data_config of this ManagementDashboardTileDetails.
Gets the description of this ManagementDashboardTileDetails.
[Required] Gets the display_name of this ManagementDashboardTileDetails.
[Required] Gets the drilldown_config of this ManagementDashboardTileDetails.
[Required] Gets the height of this ManagementDashboardTileDetails.
[Required] Gets the nls of this ManagementDashboardTileDetails.
Gets the parameters_map of this ManagementDashboardTileDetails.
[Required] Gets the row of this ManagementDashboardTileDetails.
[Required] Gets the saved_search_id of this ManagementDashboardTileDetails.
[Required] Gets the state of this ManagementDashboardTileDetails.
[Required] Gets the ui_config of this ManagementDashboardTileDetails.
[Required] Gets the width of this ManagementDashboardTileDetails.
Methods:
__init__(**kwargs)Initializes a new ManagementDashboardTileDetails object with values from keyword arguments.
- STATE_DEFAULT = 'DEFAULT'¶
A constant which can be used with the state property of a ManagementDashboardTileDetails. This constant has a value of “DEFAULT”
- STATE_DELETED = 'DELETED'¶
A constant which can be used with the state property of a ManagementDashboardTileDetails. This constant has a value of “DELETED”
- STATE_UNAUTHORIZED = 'UNAUTHORIZED'¶
A constant which can be used with the state property of a ManagementDashboardTileDetails. This constant has a value of “UNAUTHORIZED”
- __init__(**kwargs)¶
Initializes a new ManagementDashboardTileDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
display_name (str) – The value to assign to the display_name property of this ManagementDashboardTileDetails.
saved_search_id (str) – The value to assign to the saved_search_id property of this ManagementDashboardTileDetails.
row (int) – The value to assign to the row property of this ManagementDashboardTileDetails.
column (int) – The value to assign to the column property of this ManagementDashboardTileDetails.
height (int) – The value to assign to the height property of this ManagementDashboardTileDetails.
width (int) – The value to assign to the width property of this ManagementDashboardTileDetails.
nls (object) – The value to assign to the nls property of this ManagementDashboardTileDetails.
ui_config (object) – The value to assign to the ui_config property of this ManagementDashboardTileDetails.
data_config (list[object]) – The value to assign to the data_config property of this ManagementDashboardTileDetails.
state (str) – The value to assign to the state property of this ManagementDashboardTileDetails. Allowed values for this property are: “DELETED”, “UNAUTHORIZED”, “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
drilldown_config (object) – The value to assign to the drilldown_config property of this ManagementDashboardTileDetails.
parameters_map (object) – The value to assign to the parameters_map property of this ManagementDashboardTileDetails.
description (str) – The value to assign to the description property of this ManagementDashboardTileDetails.
- property column¶
[Required] Gets the column of this ManagementDashboardTileDetails. Tile’s column number.
- Returns
The column of this ManagementDashboardTileDetails.
- Return type
int
- property data_config¶
[Required] Gets the data_config of this ManagementDashboardTileDetails. It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
- Returns
The data_config of this ManagementDashboardTileDetails.
- Return type
list[object]
- property description¶
Gets the description of this ManagementDashboardTileDetails. Description of the tile.
- Returns
The description of this ManagementDashboardTileDetails.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this ManagementDashboardTileDetails. Display name of the saved search.
- Returns
The display_name of this ManagementDashboardTileDetails.
- Return type
str
- property drilldown_config¶
[Required] Gets the drilldown_config of this ManagementDashboardTileDetails. Drill-down configuration to define the destination of a drill-down action.
- Returns
The drilldown_config of this ManagementDashboardTileDetails.
- Return type
object
- property height¶
[Required] Gets the height of this ManagementDashboardTileDetails. The number of rows the tile occupies.
- Returns
The height of this ManagementDashboardTileDetails.
- Return type
int
- property nls¶
[Required] Gets the nls of this ManagementDashboardTileDetails. JSON that contains internationalization options.
- Returns
The nls of this ManagementDashboardTileDetails.
- Return type
object
- property parameters_map¶
Gets the parameters_map of this ManagementDashboardTileDetails. Specifies the saved search parameters values
- Returns
The parameters_map of this ManagementDashboardTileDetails.
- Return type
object
- property row¶
[Required] Gets the row of this ManagementDashboardTileDetails. Tile’s row number.
- Returns
The row of this ManagementDashboardTileDetails.
- Return type
int
- property saved_search_id¶
[Required] Gets the saved_search_id of this ManagementDashboardTileDetails. ID of the saved search.
- Returns
The saved_search_id of this ManagementDashboardTileDetails.
- Return type
str
- property state¶
[Required] Gets the state of this ManagementDashboardTileDetails. Current state of the saved search.
Allowed values for this property are: “DELETED”, “UNAUTHORIZED”, “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The state of this ManagementDashboardTileDetails.
- Return type
str
- property ui_config¶
[Required] Gets the ui_config of this ManagementDashboardTileDetails. It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
- Returns
The ui_config of this ManagementDashboardTileDetails.
- Return type
object
- property width¶
[Required] Gets the width of this ManagementDashboardTileDetails. The number of columns the tile occupies.
- Returns
The width of this ManagementDashboardTileDetails.
- Return type
int