Show / Hide Table of Contents

Class UpdateManagementSavedSearchDetails

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

Inheritance
object
UpdateManagementSavedSearchDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ManagementdashboardService.Models
Assembly: OCI.DotNetSDK.Managementdashboard.dll
Syntax
public class UpdateManagementSavedSearchDetails

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

OCID of the compartment in which the saved search resides.

DataConfig

Declaration
[JsonProperty(PropertyName = "dataConfig")]
public List<object> DataConfig { get; set; }
Property Value
Type Description
List<object>

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.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

Description of the saved search.

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Display name of the saved search.

DrilldownConfig

Declaration
[JsonProperty(PropertyName = "drilldownConfig")]
public List<object> DrilldownConfig { get; set; }
Property Value
Type Description
List<object>

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

FeaturesConfig

Declaration
[JsonProperty(PropertyName = "featuresConfig")]
public object FeaturesConfig { get; set; }
Property Value
Type Description
object

Contains configuration for enabling features.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

IsOobSavedSearch

Declaration
[JsonProperty(PropertyName = "isOobSavedSearch")]
public bool? IsOobSavedSearch { get; set; }
Property Value
Type Description
bool?

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.

MetadataVersion

Declaration
[JsonProperty(PropertyName = "metadataVersion")]
public string MetadataVersion { get; set; }
Property Value
Type Description
string

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

Nls

Declaration
[JsonProperty(PropertyName = "nls")]
public object Nls { get; set; }
Property Value
Type Description
object

JSON that contains internationalization options.

ParametersConfig

Declaration
[JsonProperty(PropertyName = "parametersConfig")]
public List<object> ParametersConfig { get; set; }
Property Value
Type Description
List<object>

Defines parameters for the saved search.

ProviderId

Declaration
[JsonProperty(PropertyName = "providerId")]
public string ProviderId { get; set; }
Property Value
Type Description
string

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

ProviderName

Declaration
[JsonProperty(PropertyName = "providerName")]
public string ProviderName { get; set; }
Property Value
Type Description
string

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

ProviderVersion

Declaration
[JsonProperty(PropertyName = "providerVersion")]
public string ProviderVersion { get; set; }
Property Value
Type Description
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.

ScreenImage

Declaration
[JsonProperty(PropertyName = "screenImage")]
public string ScreenImage { get; set; }
Property Value
Type Description
string

Screen image of the saved search.

Type

Declaration
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public SavedSearchTypes? Type { get; set; }
Property Value
Type Description
SavedSearchTypes?

Determines how the saved search is displayed in a dashboard.

UiConfig

Declaration
[JsonProperty(PropertyName = "uiConfig")]
public object UiConfig { get; set; }
Property Value
Type Description
object

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

WidgetTemplate

Declaration
[JsonProperty(PropertyName = "widgetTemplate")]
public string WidgetTemplate { get; set; }
Property Value
Type Description
string

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

WidgetVM

Declaration
[JsonProperty(PropertyName = "widgetVM")]
public string WidgetVM { get; set; }
Property Value
Type Description
string

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

In this article
Back to top