UpdateManagementSavedSearchDetails¶
-
class
oci.management_dashboard.models.
UpdateManagementSavedSearchDetails
(**kwargs)¶ Bases:
object
Properties of a saved search. Saved search ID must not be provided.
Attributes
TYPE_FILTER_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. TYPE_FILTER_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. TYPE_SEARCH_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. TYPE_WIDGET_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a UpdateManagementSavedSearchDetails. compartment_id
Gets the compartment_id of this UpdateManagementSavedSearchDetails. data_config
Gets the data_config of this UpdateManagementSavedSearchDetails. defined_tags
Gets the defined_tags of this UpdateManagementSavedSearchDetails. description
Gets the description of this UpdateManagementSavedSearchDetails. display_name
Gets the display_name of this UpdateManagementSavedSearchDetails. drilldown_config
Gets the drilldown_config of this UpdateManagementSavedSearchDetails. freeform_tags
Gets the freeform_tags of this UpdateManagementSavedSearchDetails. is_oob_saved_search
Gets the is_oob_saved_search of this UpdateManagementSavedSearchDetails. metadata_version
Gets the metadata_version of this UpdateManagementSavedSearchDetails. nls
Gets the nls of this UpdateManagementSavedSearchDetails. parameters_config
Gets the parameters_config of this UpdateManagementSavedSearchDetails. provider_id
Gets the provider_id of this UpdateManagementSavedSearchDetails. provider_name
Gets the provider_name of this UpdateManagementSavedSearchDetails. provider_version
Gets the provider_version of this UpdateManagementSavedSearchDetails. screen_image
Gets the screen_image of this UpdateManagementSavedSearchDetails. type
Gets the type of this UpdateManagementSavedSearchDetails. ui_config
Gets the ui_config of this UpdateManagementSavedSearchDetails. widget_template
Gets the widget_template of this UpdateManagementSavedSearchDetails. widget_vm
Gets the widget_vm of this UpdateManagementSavedSearchDetails. Methods
__init__
(**kwargs)Initializes a new UpdateManagementSavedSearchDetails 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 UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. This constant has a value of “WIDGET_SHOW_IN_DASHBOARD”
-
__init__
(**kwargs)¶ Initializes a new UpdateManagementSavedSearchDetails 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 UpdateManagementSavedSearchDetails.
- provider_id (str) – The value to assign to the provider_id property of this UpdateManagementSavedSearchDetails.
- provider_version (str) – The value to assign to the provider_version property of this UpdateManagementSavedSearchDetails.
- provider_name (str) – The value to assign to the provider_name property of this UpdateManagementSavedSearchDetails.
- compartment_id (str) – The value to assign to the compartment_id property of this UpdateManagementSavedSearchDetails.
- is_oob_saved_search (bool) – The value to assign to the is_oob_saved_search property of this UpdateManagementSavedSearchDetails.
- description (str) – The value to assign to the description property of this UpdateManagementSavedSearchDetails.
- nls (object) – The value to assign to the nls property of this UpdateManagementSavedSearchDetails.
- type (str) – The value to assign to the type property of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails.
- data_config (list[object]) – The value to assign to the data_config property of this UpdateManagementSavedSearchDetails.
- screen_image (str) – The value to assign to the screen_image property of this UpdateManagementSavedSearchDetails.
- metadata_version (str) – The value to assign to the metadata_version property of this UpdateManagementSavedSearchDetails.
- widget_template (str) – The value to assign to the widget_template property of this UpdateManagementSavedSearchDetails.
- widget_vm (str) – The value to assign to the widget_vm property of this UpdateManagementSavedSearchDetails.
- parameters_config (list[object]) – The value to assign to the parameters_config property of this UpdateManagementSavedSearchDetails.
- drilldown_config (list[object]) – The value to assign to the drilldown_config property of this UpdateManagementSavedSearchDetails.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateManagementSavedSearchDetails.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateManagementSavedSearchDetails.
-
compartment_id
¶ Gets the compartment_id of this UpdateManagementSavedSearchDetails. OCID of the compartment in which the saved search resides.
Returns: The compartment_id of this UpdateManagementSavedSearchDetails. Return type: str
-
data_config
¶ Gets the data_config of this UpdateManagementSavedSearchDetails. Array of JSON that contain data source options.
Returns: The data_config of this UpdateManagementSavedSearchDetails. Return type: list[object]
Gets the defined_tags of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this UpdateManagementSavedSearchDetails. Description of the saved search.
Returns: The description of this UpdateManagementSavedSearchDetails. Return type: str
-
display_name
¶ Gets the display_name of this UpdateManagementSavedSearchDetails. Display name of the saved search.
Returns: The display_name of this UpdateManagementSavedSearchDetails. Return type: str
-
drilldown_config
¶ Gets the drilldown_config of this UpdateManagementSavedSearchDetails. Drill-down configuration to define the destination of a drill-down action.
Returns: The drilldown_config of this UpdateManagementSavedSearchDetails. Return type: list[object]
Gets the freeform_tags of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. Return type: dict(str, str)
-
is_oob_saved_search
¶ Gets the is_oob_saved_search of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. Return type: bool
-
metadata_version
¶ Gets the metadata_version of this UpdateManagementSavedSearchDetails. Version of the metadata.
Returns: The metadata_version of this UpdateManagementSavedSearchDetails. Return type: str
-
nls
¶ Gets the nls of this UpdateManagementSavedSearchDetails. JSON that contains internationalization options.
Returns: The nls of this UpdateManagementSavedSearchDetails. Return type: object
-
parameters_config
¶ Gets the parameters_config of this UpdateManagementSavedSearchDetails. Defines parameters for the saved search.
Returns: The parameters_config of this UpdateManagementSavedSearchDetails. Return type: list[object]
-
provider_id
¶ Gets the provider_id of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. Return type: str
-
provider_name
¶ Gets the provider_name of this UpdateManagementSavedSearchDetails. Name of the service (for example, Logging Analytics) that owns the saved search.
Returns: The provider_name of this UpdateManagementSavedSearchDetails. Return type: str
-
provider_version
¶ Gets the provider_version of this UpdateManagementSavedSearchDetails. Version of the service that owns this saved search.
Returns: The provider_version of this UpdateManagementSavedSearchDetails. Return type: str
-
screen_image
¶ Gets the screen_image of this UpdateManagementSavedSearchDetails. Screen image of the saved search.
Returns: The screen_image of this UpdateManagementSavedSearchDetails. Return type: str
-
type
¶ Gets the type of this UpdateManagementSavedSearchDetails. 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 UpdateManagementSavedSearchDetails. Return type: str
-
ui_config
¶ Gets the ui_config of this UpdateManagementSavedSearchDetails. JSON that contains user interface options.
Returns: The ui_config of this UpdateManagementSavedSearchDetails. Return type: object
-
widget_template
¶ Gets the widget_template of this UpdateManagementSavedSearchDetails. Reference to the HTML file of the widget.
Returns: The widget_template of this UpdateManagementSavedSearchDetails. Return type: str
-
widget_vm
¶ Gets the widget_vm of this UpdateManagementSavedSearchDetails. Reference to the view model of the widget.
Returns: The widget_vm of this UpdateManagementSavedSearchDetails. Return type: str
-