Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateManagementSavedSearchDetails

Properties of a saved search. Saved search ID must not be provided.

Properties

Optional compartmentId

compartmentId: undefined | string

OCID of the compartment in which the saved search resides.

Optional 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"}}}

Optional description

description: undefined | string

Description of the saved search.

Optional displayName

displayName: undefined | 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"}}

Optional isOobSavedSearch

isOobSavedSearch: undefined | false | true

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.

Optional metadataVersion

metadataVersion: undefined | string

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

Optional nls

nls: any

JSON that contains internationalization options.

Optional parametersConfig

parametersConfig: Array<any>

Defines parameters for the saved search.

Optional providerId

providerId: undefined | string

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

Optional providerName

providerName: undefined | string

The user friendly name of the service (for example, Logging Analytics) that owns the saved search.

Optional providerVersion

providerVersion: undefined | string

The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

Optional screenImage

screenImage: undefined | string

Screen image of the saved search.

Optional type

type: model.SavedSearchTypes

Determines how the saved search is displayed in a dashboard.

Optional 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.

Optional widgetTemplate

widgetTemplate: undefined | string

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

Optional widgetVM

widgetVM: undefined | string

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

Functions

getDeserializedJsonObj

getJsonObj