Class ManagementSavedSearchForImportDetails
Properties of a saved search.
Inherited Members
Namespace: Oci.ManagementdashboardService.Models
Assembly: OCI.DotNetSDK.Managementdashboard.dll
Syntax
public class ManagementSavedSearchForImportDetails
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | OCID of the compartment in which the saved search resides. |
Remarks
Required
DataConfig
Declaration
[Required(ErrorMessage = "DataConfig is required.")]
[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. |
Remarks
Required
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
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Description of the saved search. |
Remarks
Required
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | Display name of the saved search. |
Remarks
Required
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"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | ID of the saved search. |
Remarks
Required
IsOobSavedSearch
Declaration
[Required(ErrorMessage = "IsOobSavedSearch is required.")]
[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. |
Remarks
Required
MetadataVersion
Declaration
[Required(ErrorMessage = "MetadataVersion is required.")]
[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. |
Remarks
Required
Nls
Declaration
[Required(ErrorMessage = "Nls is required.")]
[JsonProperty(PropertyName = "nls")]
public object Nls { get; set; }
Property Value
Type | Description |
---|---|
object | JSON that contains internationalization options. |
Remarks
Required
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
[Required(ErrorMessage = "ProviderId is required.")]
[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. |
Remarks
Required
ProviderName
Declaration
[Required(ErrorMessage = "ProviderName is required.")]
[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. |
Remarks
Required
ProviderVersion
Declaration
[Required(ErrorMessage = "ProviderVersion is required.")]
[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. |
Remarks
Required
ScreenImage
Declaration
[Required(ErrorMessage = "ScreenImage is required.")]
[JsonProperty(PropertyName = "screenImage")]
public string ScreenImage { get; set; }
Property Value
Type | Description |
---|---|
string | Screen image of the saved search. |
Remarks
Required
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SavedSearchTypes? Type { get; set; }
Property Value
Type | Description |
---|---|
SavedSearchTypes? | Determines how the saved search is displayed in a dashboard. |
Remarks
Required
UiConfig
Declaration
[Required(ErrorMessage = "UiConfig is required.")]
[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. |
Remarks
Required
WidgetTemplate
Declaration
[Required(ErrorMessage = "WidgetTemplate is required.")]
[JsonProperty(PropertyName = "widgetTemplate")]
public string WidgetTemplate { get; set; }
Property Value
Type | Description |
---|---|
string | The UI template that the saved search uses to render itself. |
Remarks
Required
WidgetVM
Declaration
[Required(ErrorMessage = "WidgetVM is required.")]
[JsonProperty(PropertyName = "widgetVM")]
public string WidgetVM { get; set; }
Property Value
Type | Description |
---|---|
string | The View Model that the saved search uses to render itself. |
Remarks
Required