Class ManagementDashboard

Properties of a dashboard, including dashboard ID.

Inheritance

object

ManagementDashboard

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 ManagementDashboard

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

DataConfig

Declaration

[Required(ErrorMessage = "DataConfig is required.")]
[JsonProperty(PropertyName = "dataConfig")]
public List<object> DataConfig { get; set; }

Property Value

Type	Description
List<object>	Array of JSON that contain data source options.

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

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 dashboard. Same as dashboardId.

Remarks

Required

IsFavorite

Declaration

[Required(ErrorMessage = "IsFavorite is required.")]
[JsonProperty(PropertyName = "isFavorite")]
public bool? IsFavorite { get; set; }

Property Value

Type	Description
bool?	Determines whether the dashboard is set as favorite.

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

IsShowDescription

Declaration

[Required(ErrorMessage = "IsShowDescription is required.")]
[JsonProperty(PropertyName = "isShowDescription")]
public bool? IsShowDescription { get; set; }

Property Value

Type	Description
bool?	Determines whether the description of the dashboard is displayed.

Remarks

Required

IsShowInHome

Declaration

[Required(ErrorMessage = "IsShowInHome is required.")]
[JsonProperty(PropertyName = "isShowInHome")]
public bool? IsShowInHome { get; set; }

Property Value

Type	Description
bool?	Determines whether the dashboard will be displayed in Dashboard Home.

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?	State of 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

ParametersConfig

Declaration

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

Property Value

Type	Description
List<object>	Defines parameters for the dashboard.

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	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	Version of the service that owns the dashboard.

Remarks

Required

SavedSearches

Declaration

[Required(ErrorMessage = "SavedSearches is required.")]
[JsonProperty(PropertyName = "savedSearches")]
public List<ManagementSavedSearch> SavedSearches { get; set; }

Property Value

Type	Description
List<ManagementSavedSearch>	Array of saved searches in the dashboard.

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

Tiles

Declaration

[Required(ErrorMessage = "Tiles is required.")]
[JsonProperty(PropertyName = "tiles")]
public List<ManagementDashboardTileDetails> Tiles { get; set; }

Property Value

Type	Description
List<ManagementDashboardTileDetails>	Array of dashboard tiles.

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

UiConfig

Declaration

[Required(ErrorMessage = "UiConfig is required.")]
[JsonProperty(PropertyName = "uiConfig")]
public object UiConfig { get; set; }

Property Value

Type	Description
object	JSON that contains user interface options.

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