CreateManagementSavedSearchDetails¶
-
class
oci.management_dashboard.models.
CreateManagementSavedSearchDetails
(**kwargs)¶ Bases:
object
Properties of a saved search.
Attributes
TYPE_FILTER_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. TYPE_FILTER_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. TYPE_SEARCH_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. TYPE_WIDGET_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a CreateManagementSavedSearchDetails. compartment_id
[Required] Gets the compartment_id of this CreateManagementSavedSearchDetails. data_config
[Required] Gets the data_config of this CreateManagementSavedSearchDetails. defined_tags
Gets the defined_tags of this CreateManagementSavedSearchDetails. description
[Required] Gets the description of this CreateManagementSavedSearchDetails. display_name
[Required] Gets the display_name of this CreateManagementSavedSearchDetails. drilldown_config
Gets the drilldown_config of this CreateManagementSavedSearchDetails. freeform_tags
Gets the freeform_tags of this CreateManagementSavedSearchDetails. id
Gets the id of this CreateManagementSavedSearchDetails. is_oob_saved_search
[Required] Gets the is_oob_saved_search of this CreateManagementSavedSearchDetails. metadata_version
[Required] Gets the metadata_version of this CreateManagementSavedSearchDetails. nls
[Required] Gets the nls of this CreateManagementSavedSearchDetails. parameters_config
Gets the parameters_config of this CreateManagementSavedSearchDetails. provider_id
[Required] Gets the provider_id of this CreateManagementSavedSearchDetails. provider_name
[Required] Gets the provider_name of this CreateManagementSavedSearchDetails. provider_version
[Required] Gets the provider_version of this CreateManagementSavedSearchDetails. screen_image
[Required] Gets the screen_image of this CreateManagementSavedSearchDetails. type
[Required] Gets the type of this CreateManagementSavedSearchDetails. ui_config
[Required] Gets the ui_config of this CreateManagementSavedSearchDetails. widget_template
[Required] Gets the widget_template of this CreateManagementSavedSearchDetails. widget_vm
[Required] Gets the widget_vm of this CreateManagementSavedSearchDetails. Methods
__init__
(**kwargs)Initializes a new CreateManagementSavedSearchDetails object with values from keyword arguments. -
TYPE_FILTER_DONT_SHOW_IN_DASHBOARD
= 'FILTER_DONT_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “FILTER_DONT_SHOW_IN_DASHBOARD”
-
TYPE_FILTER_SHOW_IN_DASHBOARD
= 'FILTER_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “FILTER_SHOW_IN_DASHBOARD”
-
TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD
= 'SEARCH_DONT_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “SEARCH_DONT_SHOW_IN_DASHBOARD”
-
TYPE_SEARCH_SHOW_IN_DASHBOARD
= 'SEARCH_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “SEARCH_SHOW_IN_DASHBOARD”
-
TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD
= 'WIDGET_DONT_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “WIDGET_DONT_SHOW_IN_DASHBOARD”
-
TYPE_WIDGET_SHOW_IN_DASHBOARD
= 'WIDGET_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a CreateManagementSavedSearchDetails. This constant has a value of “WIDGET_SHOW_IN_DASHBOARD”
-
__init__
(**kwargs)¶ Initializes a new CreateManagementSavedSearchDetails 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 CreateManagementSavedSearchDetails.
- display_name (str) – The value to assign to the display_name property of this CreateManagementSavedSearchDetails.
- provider_id (str) – The value to assign to the provider_id property of this CreateManagementSavedSearchDetails.
- provider_version (str) – The value to assign to the provider_version property of this CreateManagementSavedSearchDetails.
- provider_name (str) – The value to assign to the provider_name property of this CreateManagementSavedSearchDetails.
- compartment_id (str) – The value to assign to the compartment_id property of this CreateManagementSavedSearchDetails.
- is_oob_saved_search (bool) – The value to assign to the is_oob_saved_search property of this CreateManagementSavedSearchDetails.
- description (str) – The value to assign to the description property of this CreateManagementSavedSearchDetails.
- nls (object) – The value to assign to the nls property of this CreateManagementSavedSearchDetails.
- type (str) – The value to assign to the type property of this CreateManagementSavedSearchDetails. Allowed values for this property are: “SEARCH_SHOW_IN_DASHBOARD”, “SEARCH_DONT_SHOW_IN_DASHBOARD”, “WIDGET_SHOW_IN_DASHBOARD”, “WIDGET_DONT_SHOW_IN_DASHBOARD”, “FILTER_SHOW_IN_DASHBOARD”, “FILTER_DONT_SHOW_IN_DASHBOARD”
- ui_config (object) – The value to assign to the ui_config property of this CreateManagementSavedSearchDetails.
- data_config (list[object]) – The value to assign to the data_config property of this CreateManagementSavedSearchDetails.
- screen_image (str) – The value to assign to the screen_image property of this CreateManagementSavedSearchDetails.
- metadata_version (str) – The value to assign to the metadata_version property of this CreateManagementSavedSearchDetails.
- widget_template (str) – The value to assign to the widget_template property of this CreateManagementSavedSearchDetails.
- widget_vm (str) – The value to assign to the widget_vm property of this CreateManagementSavedSearchDetails.
- parameters_config (list[object]) – The value to assign to the parameters_config property of this CreateManagementSavedSearchDetails.
- drilldown_config (list[object]) – The value to assign to the drilldown_config property of this CreateManagementSavedSearchDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateManagementSavedSearchDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateManagementSavedSearchDetails.
-
compartment_id
¶ [Required] Gets the compartment_id of this CreateManagementSavedSearchDetails. OCID of the compartment in which the saved search resides.
Returns: The compartment_id of this CreateManagementSavedSearchDetails. Return type: str
-
data_config
¶ [Required] Gets the data_config of this CreateManagementSavedSearchDetails. Array of JSON that contain data source options.
Returns: The data_config of this CreateManagementSavedSearchDetails. Return type: list[object]
Gets the defined_tags of this CreateManagementSavedSearchDetails. 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 CreateManagementSavedSearchDetails. Return type: dict(str, dict(str, object))
-
description
¶ [Required] Gets the description of this CreateManagementSavedSearchDetails. Description of the saved search.
Returns: The description of this CreateManagementSavedSearchDetails. Return type: str
-
display_name
¶ [Required] Gets the display_name of this CreateManagementSavedSearchDetails. Display name of the saved search.
Returns: The display_name of this CreateManagementSavedSearchDetails. Return type: str
-
drilldown_config
¶ Gets the drilldown_config of this CreateManagementSavedSearchDetails. Drill-down configuration to define the destination of a drill-down action.
Returns: The drilldown_config of this CreateManagementSavedSearchDetails. Return type: list[object]
Gets the freeform_tags of this CreateManagementSavedSearchDetails. 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 CreateManagementSavedSearchDetails. Return type: dict(str, str)
-
id
¶ Gets the id of this CreateManagementSavedSearchDetails. ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.
Returns: The id of this CreateManagementSavedSearchDetails. Return type: str
-
is_oob_saved_search
¶ [Required] Gets the is_oob_saved_search of this CreateManagementSavedSearchDetails. Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
Returns: The is_oob_saved_search of this CreateManagementSavedSearchDetails. Return type: bool
-
metadata_version
¶ [Required] Gets the metadata_version of this CreateManagementSavedSearchDetails. Version of the metadata.
Returns: The metadata_version of this CreateManagementSavedSearchDetails. Return type: str
-
nls
¶ [Required] Gets the nls of this CreateManagementSavedSearchDetails. JSON that contains internationalization options.
Returns: The nls of this CreateManagementSavedSearchDetails. Return type: object
-
parameters_config
¶ Gets the parameters_config of this CreateManagementSavedSearchDetails. Defines parameters for the saved search.
Returns: The parameters_config of this CreateManagementSavedSearchDetails. Return type: list[object]
-
provider_id
¶ [Required] Gets the provider_id of this CreateManagementSavedSearchDetails. ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
Returns: The provider_id of this CreateManagementSavedSearchDetails. Return type: str
-
provider_name
¶ [Required] Gets the provider_name of this CreateManagementSavedSearchDetails. Name of the service (for example, Logging Analytics) that owns the saved search.
Returns: The provider_name of this CreateManagementSavedSearchDetails. Return type: str
-
provider_version
¶ [Required] Gets the provider_version of this CreateManagementSavedSearchDetails. Version of the service that owns this saved search.
Returns: The provider_version of this CreateManagementSavedSearchDetails. Return type: str
-
screen_image
¶ [Required] Gets the screen_image of this CreateManagementSavedSearchDetails. Screen image of the saved search.
Returns: The screen_image of this CreateManagementSavedSearchDetails. Return type: str
-
type
¶ [Required] Gets the type of this CreateManagementSavedSearchDetails. Determines how the saved search is displayed in a dashboard.
Allowed values for this property are: “SEARCH_SHOW_IN_DASHBOARD”, “SEARCH_DONT_SHOW_IN_DASHBOARD”, “WIDGET_SHOW_IN_DASHBOARD”, “WIDGET_DONT_SHOW_IN_DASHBOARD”, “FILTER_SHOW_IN_DASHBOARD”, “FILTER_DONT_SHOW_IN_DASHBOARD”
Returns: The type of this CreateManagementSavedSearchDetails. Return type: str
-
ui_config
¶ [Required] Gets the ui_config of this CreateManagementSavedSearchDetails. JSON that contains user interface options.
Returns: The ui_config of this CreateManagementSavedSearchDetails. Return type: object
-
widget_template
¶ [Required] Gets the widget_template of this CreateManagementSavedSearchDetails. Reference to the HTML file of the widget.
Returns: The widget_template of this CreateManagementSavedSearchDetails. Return type: str
-
widget_vm
¶ [Required] Gets the widget_vm of this CreateManagementSavedSearchDetails. Reference to the view model of the widget.
Returns: The widget_vm of this CreateManagementSavedSearchDetails. Return type: str
-