Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ManagementSavedSearch

Properties of a saved search.

Properties

compartmentId

compartmentId: string

OCID of the compartment in which the saved search resides.

createdBy

createdBy: string

The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.

dataConfig

dataConfig: Array<any>

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.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

description

description: string

Description of the saved search.

displayName

displayName: string

Display name of the saved search.

Optional drilldownConfig

drilldownConfig: Array<any>

Drill-down configuration to define the destination of a drill-down action.

Optional featuresConfig

featuresConfig: any

Contains configuration for enabling features.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

ID of the saved search.

isOobSavedSearch

isOobSavedSearch: boolean

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.

lifecycleState

lifecycleState: LifecycleStates

OCI lifecycle status. This is automatically managed by the system.

metadataVersion

metadataVersion: string

The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

nls

nls: any

JSON that contains internationalization options.

Optional parametersConfig

parametersConfig: Array<any>

Defines parameters for the saved search.

providerId

providerId: string

ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.

providerName

providerName: string

Name of the service (for example, Logging Analytics) that owns the saved search.

providerVersion

providerVersion: string

Version of the service that owns this saved search.

screenImage

screenImage: string

Screen image of the saved search.

timeCreated

timeCreated: Date

Date and time the saved search was created.

timeUpdated

timeUpdated: Date

Date and time the saved search was updated.

type

Determines how the saved search is displayed in a dashboard.

uiConfig

uiConfig: any

It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

updatedBy

updatedBy: string

The principle id of the user that updated this saved search.

widgetTemplate

widgetTemplate: string

The UI template that the saved search uses to render itself.

widgetVM

widgetVM: string

The View Model that the saved search uses to render itself.

Functions

getDeserializedJsonObj

getJsonObj