ManagementSavedSearchSummary¶
-
class
oci.management_dashboard.models.
ManagementSavedSearchSummary
(**kwargs)¶ Bases:
object
Summary of the properties of a saved search.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a ManagementSavedSearchSummary. TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a ManagementSavedSearchSummary. TYPE_SEARCH_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a ManagementSavedSearchSummary. TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a ManagementSavedSearchSummary. TYPE_WIDGET_SHOW_IN_DASHBOARD
A constant which can be used with the type property of a ManagementSavedSearchSummary. compartment_id
[Required] Gets the compartment_id of this ManagementSavedSearchSummary. created_by
[Required] Gets the created_by of this ManagementSavedSearchSummary. data_config
[Required] Gets the data_config of this ManagementSavedSearchSummary. defined_tags
Gets the defined_tags of this ManagementSavedSearchSummary. description
[Required] Gets the description of this ManagementSavedSearchSummary. display_name
[Required] Gets the display_name of this ManagementSavedSearchSummary. freeform_tags
Gets the freeform_tags of this ManagementSavedSearchSummary. id
[Required] Gets the id of this ManagementSavedSearchSummary. is_oob_saved_search
[Required] Gets the is_oob_saved_search of this ManagementSavedSearchSummary. lifecycle_state
[Required] Gets the lifecycle_state of this ManagementSavedSearchSummary. metadata_version
[Required] Gets the metadata_version of this ManagementSavedSearchSummary. nls
[Required] Gets the nls of this ManagementSavedSearchSummary. provider_id
[Required] Gets the provider_id of this ManagementSavedSearchSummary. screen_image
[Required] Gets the screen_image of this ManagementSavedSearchSummary. time_created
[Required] Gets the time_created of this ManagementSavedSearchSummary. time_updated
[Required] Gets the time_updated of this ManagementSavedSearchSummary. type
[Required] Gets the type of this ManagementSavedSearchSummary. ui_config
[Required] Gets the ui_config of this ManagementSavedSearchSummary. updated_by
[Required] Gets the updated_by of this ManagementSavedSearchSummary. widget_template
[Required] Gets the widget_template of this ManagementSavedSearchSummary. widget_vm
[Required] Gets the widget_vm of this ManagementSavedSearchSummary. Methods
__init__
(**kwargs)Initializes a new ManagementSavedSearchSummary object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a ManagementSavedSearchSummary. This constant has a value of “ACTIVE”
-
TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD
= 'SEARCH_DONT_SHOW_IN_DASHBOARD'¶ A constant which can be used with the type property of a ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. This constant has a value of “WIDGET_SHOW_IN_DASHBOARD”
-
__init__
(**kwargs)¶ Initializes a new ManagementSavedSearchSummary 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 ManagementSavedSearchSummary.
- display_name (str) – The value to assign to the display_name property of this ManagementSavedSearchSummary.
- is_oob_saved_search (bool) – The value to assign to the is_oob_saved_search property of this ManagementSavedSearchSummary.
- provider_id (str) – The value to assign to the provider_id property of this ManagementSavedSearchSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this ManagementSavedSearchSummary.
- description (str) – The value to assign to the description property of this ManagementSavedSearchSummary.
- nls (object) – The value to assign to the nls property of this ManagementSavedSearchSummary.
- type (str) – The value to assign to the type property of this ManagementSavedSearchSummary. Allowed values for this property are: “SEARCH_SHOW_IN_DASHBOARD”, “SEARCH_DONT_SHOW_IN_DASHBOARD”, “WIDGET_SHOW_IN_DASHBOARD”, “WIDGET_DONT_SHOW_IN_DASHBOARD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- ui_config (object) – The value to assign to the ui_config property of this ManagementSavedSearchSummary.
- data_config (list[object]) – The value to assign to the data_config property of this ManagementSavedSearchSummary.
- created_by (str) – The value to assign to the created_by property of this ManagementSavedSearchSummary.
- updated_by (str) – The value to assign to the updated_by property of this ManagementSavedSearchSummary.
- time_created (datetime) – The value to assign to the time_created property of this ManagementSavedSearchSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this ManagementSavedSearchSummary.
- screen_image (str) – The value to assign to the screen_image property of this ManagementSavedSearchSummary.
- metadata_version (str) – The value to assign to the metadata_version property of this ManagementSavedSearchSummary.
- widget_template (str) – The value to assign to the widget_template property of this ManagementSavedSearchSummary.
- widget_vm (str) – The value to assign to the widget_vm property of this ManagementSavedSearchSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementSavedSearchSummary. Allowed values for this property are: “ACTIVE”, ‘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 ManagementSavedSearchSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementSavedSearchSummary.
-
compartment_id
¶ [Required] Gets the compartment_id of this ManagementSavedSearchSummary. OCID of the compartment in which the saved search resides.
Returns: The compartment_id of this ManagementSavedSearchSummary. Return type: str
-
created_by
¶ [Required] Gets the created_by of this ManagementSavedSearchSummary. User who created the saved search.
Returns: The created_by of this ManagementSavedSearchSummary. Return type: str
-
data_config
¶ [Required] Gets the data_config of this ManagementSavedSearchSummary. Array of JSON that contain data source options.
Returns: The data_config of this ManagementSavedSearchSummary. Return type: list[object]
Gets the defined_tags of this ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. Return type: dict(str, dict(str, object))
-
description
¶ [Required] Gets the description of this ManagementSavedSearchSummary. Description of the saved search.
Returns: The description of this ManagementSavedSearchSummary. Return type: str
-
display_name
¶ [Required] Gets the display_name of this ManagementSavedSearchSummary. Display name of the saved search.
Returns: The display_name of this ManagementSavedSearchSummary. Return type: str
Gets the freeform_tags of this ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this ManagementSavedSearchSummary. ID of the saved search.
Returns: The id of this ManagementSavedSearchSummary. Return type: str
-
is_oob_saved_search
¶ [Required] Gets the is_oob_saved_search of this ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. Return type: bool
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this ManagementSavedSearchSummary. Current lifecycle state of the saved search.
Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this ManagementSavedSearchSummary. Return type: str
-
metadata_version
¶ [Required] Gets the metadata_version of this ManagementSavedSearchSummary. Version of the metadata.
Returns: The metadata_version of this ManagementSavedSearchSummary. Return type: str
-
nls
¶ [Required] Gets the nls of this ManagementSavedSearchSummary. JSON that contains internationalization options.
Returns: The nls of this ManagementSavedSearchSummary. Return type: object
-
provider_id
¶ [Required] Gets the provider_id of this ManagementSavedSearchSummary. 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 ManagementSavedSearchSummary. Return type: str
-
screen_image
¶ [Required] Gets the screen_image of this ManagementSavedSearchSummary. Screen image of the saved search.
Returns: The screen_image of this ManagementSavedSearchSummary. Return type: str
-
time_created
¶ [Required] Gets the time_created of this ManagementSavedSearchSummary. Date and time the saved search was created.
Returns: The time_created of this ManagementSavedSearchSummary. Return type: datetime
-
time_updated
¶ [Required] Gets the time_updated of this ManagementSavedSearchSummary. Date and time the saved search was updated.
Returns: The time_updated of this ManagementSavedSearchSummary. Return type: datetime
-
type
¶ [Required] Gets the type of this ManagementSavedSearchSummary. 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this ManagementSavedSearchSummary. Return type: str
-
ui_config
¶ [Required] Gets the ui_config of this ManagementSavedSearchSummary. JSON that contains user interface options.
Returns: The ui_config of this ManagementSavedSearchSummary. Return type: object
-
updated_by
¶ [Required] Gets the updated_by of this ManagementSavedSearchSummary. User who updated the saved search.
Returns: The updated_by of this ManagementSavedSearchSummary. Return type: str
-
widget_template
¶ [Required] Gets the widget_template of this ManagementSavedSearchSummary. Reference to the HTML file of the widget.
Returns: The widget_template of this ManagementSavedSearchSummary. Return type: str
-
widget_vm
¶ [Required] Gets the widget_vm of this ManagementSavedSearchSummary. Reference to the view model of the widget.
Returns: The widget_vm of this ManagementSavedSearchSummary. Return type: str
-