ManagementSavedSearch

class oci.management_dashboard.models.ManagementSavedSearch(**kwargs)

Bases: object

Properties of a saved search.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a ManagementSavedSearch.
TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD A constant which can be used with the type property of a ManagementSavedSearch.
TYPE_SEARCH_SHOW_IN_DASHBOARD A constant which can be used with the type property of a ManagementSavedSearch.
TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD A constant which can be used with the type property of a ManagementSavedSearch.
TYPE_WIDGET_SHOW_IN_DASHBOARD A constant which can be used with the type property of a ManagementSavedSearch.
compartment_id [Required] Gets the compartment_id of this ManagementSavedSearch.
created_by [Required] Gets the created_by of this ManagementSavedSearch.
data_config [Required] Gets the data_config of this ManagementSavedSearch.
defined_tags Gets the defined_tags of this ManagementSavedSearch.
description [Required] Gets the description of this ManagementSavedSearch.
display_name [Required] Gets the display_name of this ManagementSavedSearch.
freeform_tags Gets the freeform_tags of this ManagementSavedSearch.
id [Required] Gets the id of this ManagementSavedSearch.
is_oob_saved_search [Required] Gets the is_oob_saved_search of this ManagementSavedSearch.
lifecycle_state [Required] Gets the lifecycle_state of this ManagementSavedSearch.
metadata_version [Required] Gets the metadata_version of this ManagementSavedSearch.
nls [Required] Gets the nls of this ManagementSavedSearch.
parameters_config Gets the parameters_config of this ManagementSavedSearch.
provider_id [Required] Gets the provider_id of this ManagementSavedSearch.
provider_name [Required] Gets the provider_name of this ManagementSavedSearch.
provider_version [Required] Gets the provider_version of this ManagementSavedSearch.
screen_image [Required] Gets the screen_image of this ManagementSavedSearch.
time_created [Required] Gets the time_created of this ManagementSavedSearch.
time_updated [Required] Gets the time_updated of this ManagementSavedSearch.
type [Required] Gets the type of this ManagementSavedSearch.
ui_config [Required] Gets the ui_config of this ManagementSavedSearch.
updated_by [Required] Gets the updated_by of this ManagementSavedSearch.
widget_template [Required] Gets the widget_template of this ManagementSavedSearch.
widget_vm [Required] Gets the widget_vm of this ManagementSavedSearch.

Methods

__init__(**kwargs) Initializes a new ManagementSavedSearch object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ManagementSavedSearch. 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 ManagementSavedSearch. 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 ManagementSavedSearch. 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 ManagementSavedSearch. 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 ManagementSavedSearch. This constant has a value of “WIDGET_SHOW_IN_DASHBOARD”

__init__(**kwargs)

Initializes a new ManagementSavedSearch 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 ManagementSavedSearch.
  • display_name (str) – The value to assign to the display_name property of this ManagementSavedSearch.
  • provider_id (str) – The value to assign to the provider_id property of this ManagementSavedSearch.
  • provider_version (str) – The value to assign to the provider_version property of this ManagementSavedSearch.
  • provider_name (str) – The value to assign to the provider_name property of this ManagementSavedSearch.
  • compartment_id (str) – The value to assign to the compartment_id property of this ManagementSavedSearch.
  • is_oob_saved_search (bool) – The value to assign to the is_oob_saved_search property of this ManagementSavedSearch.
  • description (str) – The value to assign to the description property of this ManagementSavedSearch.
  • nls (object) – The value to assign to the nls property of this ManagementSavedSearch.
  • type (str) – The value to assign to the type property of this ManagementSavedSearch. 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 ManagementSavedSearch.
  • data_config (list[object]) – The value to assign to the data_config property of this ManagementSavedSearch.
  • created_by (str) – The value to assign to the created_by property of this ManagementSavedSearch.
  • updated_by (str) – The value to assign to the updated_by property of this ManagementSavedSearch.
  • time_created (datetime) – The value to assign to the time_created property of this ManagementSavedSearch.
  • time_updated (datetime) – The value to assign to the time_updated property of this ManagementSavedSearch.
  • screen_image (str) – The value to assign to the screen_image property of this ManagementSavedSearch.
  • metadata_version (str) – The value to assign to the metadata_version property of this ManagementSavedSearch.
  • widget_template (str) – The value to assign to the widget_template property of this ManagementSavedSearch.
  • widget_vm (str) – The value to assign to the widget_vm property of this ManagementSavedSearch.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ManagementSavedSearch. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • parameters_config (list[object]) – The value to assign to the parameters_config property of this ManagementSavedSearch.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ManagementSavedSearch.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ManagementSavedSearch.
compartment_id

[Required] Gets the compartment_id of this ManagementSavedSearch. OCID of the compartment in which the saved search resides.

Returns:The compartment_id of this ManagementSavedSearch.
Return type:str
created_by

[Required] Gets the created_by of this ManagementSavedSearch. User who created the saved search.

Returns:The created_by of this ManagementSavedSearch.
Return type:str
data_config

[Required] Gets the data_config of this ManagementSavedSearch. Array of JSON that contain data source options.

Returns:The data_config of this ManagementSavedSearch.
Return type:list[object]
defined_tags

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

[Required] Gets the description of this ManagementSavedSearch. Description of the saved search.

Returns:The description of this ManagementSavedSearch.
Return type:str
display_name

[Required] Gets the display_name of this ManagementSavedSearch. Display name of the saved search.

Returns:The display_name of this ManagementSavedSearch.
Return type:str
freeform_tags

Gets the freeform_tags of this ManagementSavedSearch. 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 ManagementSavedSearch.
Return type:dict(str, str)
id

[Required] Gets the id of this ManagementSavedSearch. ID of the saved search.

Returns:The id of this ManagementSavedSearch.
Return type:str

[Required] Gets the is_oob_saved_search of this ManagementSavedSearch. 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 ManagementSavedSearch.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this ManagementSavedSearch. State of dashboard.

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 ManagementSavedSearch.
Return type:str
metadata_version

[Required] Gets the metadata_version of this ManagementSavedSearch. Version of the metadata.

Returns:The metadata_version of this ManagementSavedSearch.
Return type:str
nls

[Required] Gets the nls of this ManagementSavedSearch. JSON that contains internationalization options.

Returns:The nls of this ManagementSavedSearch.
Return type:object
parameters_config

Gets the parameters_config of this ManagementSavedSearch. Defines parameters for the saved search.

Returns:The parameters_config of this ManagementSavedSearch.
Return type:list[object]
provider_id

[Required] Gets the provider_id of this ManagementSavedSearch. 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 ManagementSavedSearch.
Return type:str
provider_name

[Required] Gets the provider_name of this ManagementSavedSearch. Name of the service (for example, Logging Analytics) that owns the saved search.

Returns:The provider_name of this ManagementSavedSearch.
Return type:str
provider_version

[Required] Gets the provider_version of this ManagementSavedSearch. Version of the service that owns this saved search.

Returns:The provider_version of this ManagementSavedSearch.
Return type:str
screen_image

[Required] Gets the screen_image of this ManagementSavedSearch. Screen image of the saved search.

Returns:The screen_image of this ManagementSavedSearch.
Return type:str
time_created

[Required] Gets the time_created of this ManagementSavedSearch. Date and time the saved search was created.

Returns:The time_created of this ManagementSavedSearch.
Return type:datetime
time_updated

[Required] Gets the time_updated of this ManagementSavedSearch. Date and time the saved search was updated.

Returns:The time_updated of this ManagementSavedSearch.
Return type:datetime
type

[Required] Gets the type of this ManagementSavedSearch. 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 ManagementSavedSearch.
Return type:str
ui_config

[Required] Gets the ui_config of this ManagementSavedSearch. JSON that contains user interface options.

Returns:The ui_config of this ManagementSavedSearch.
Return type:object
updated_by

[Required] Gets the updated_by of this ManagementSavedSearch. User who updated the saved search.

Returns:The updated_by of this ManagementSavedSearch.
Return type:str
widget_template

[Required] Gets the widget_template of this ManagementSavedSearch. Reference to the HTML file of the widget.

Returns:The widget_template of this ManagementSavedSearch.
Return type:str
widget_vm

[Required] Gets the widget_vm of this ManagementSavedSearch. Reference to the view model of the widget.

Returns:The widget_vm of this ManagementSavedSearch.
Return type:str