Class ManagementDashboardSummary
Summary of the properties of a dashboard.
Inherited Members
Namespace: Oci.ManagementdashboardService.Models
Assembly: OCI.DotNetSDK.Managementdashboard.dll
Syntax
public class ManagementDashboardSummary
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 dashboard resides. |
Remarks
Required
CreatedBy
Declaration
[Required(ErrorMessage = "CreatedBy is required.")]
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | User who created the dashboard. |
Remarks
Required
DashboardId
Declaration
[Required(ErrorMessage = "DashboardId is required.")]
[JsonProperty(PropertyName = "dashboardId")]
public string DashboardId { get; set; }
Property Value
Type | Description |
---|---|
string | ID of the dashboard. Same as id. |
Remarks
Required
DefinedTags
Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[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"}} |
Remarks
Required
Description
Declaration
[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Description of the dashboard. |
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 dashboard. |
Remarks
Required
FeaturesConfig
Declaration
[JsonProperty(PropertyName = "featuresConfig")]
public object FeaturesConfig { get; set; }
Property Value
Type | Description |
---|---|
object | Contains configuration for enabling features. |
FreeformTags
Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[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"} |
Remarks
Required
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | ID of the dashboard. Same as dashboardId. |
Remarks
Required
IsOobDashboard
Declaration
[Required(ErrorMessage = "IsOobDashboard is required.")]
[JsonProperty(PropertyName = "isOobDashboard")]
public bool? IsOobDashboard { get; set; }
Property Value
Type | Description |
---|---|
bool? | Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleStates? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleStates? | Current lifecycle state of the dashboard. |
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
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 dashboard. 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 dashboard. |
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 dashboard. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time the dashboard was created. |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Date and time the dashboard was updated. |
Remarks
Required
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type | Description |
---|---|
string | Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. |
Remarks
Required
UpdatedBy
Declaration
[Required(ErrorMessage = "UpdatedBy is required.")]
[JsonProperty(PropertyName = "updatedBy")]
public string UpdatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | User who updated the dashboard. |
Remarks
Required