@Generated(value="OracleSDKGenerator",
comments="API Version: 20200901")
public final class CreateManagementDashboardDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB)
dashboards.
Note: Objects should always be created or deserialized using the CreateManagementDashboardDetails.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the CreateManagementDashboardDetails.Builder, which maintain a
set of all explicitly set fields called CreateManagementDashboardDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateManagementDashboardDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateManagementDashboardDetails(String dashboardId,
String providerId,
String providerName,
String providerVersion,
List<ManagementDashboardTileDetails> tiles,
String displayName,
String description,
String compartmentId,
Boolean isOobDashboard,
Boolean isShowInHome,
String metadataVersion,
Boolean isShowDescription,
String screenImage,
Object nls,
Object uiConfig,
List<Object> dataConfig,
String type,
Boolean isFavorite,
List<Object> parametersConfig,
Object featuresConfig,
List<Object> drilldownConfig,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateManagementDashboardDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
OCID of the compartment in which the dashboard resides.
|
String |
getDashboardId()
ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
|
List<Object> |
getDataConfig()
Array of JSON that contain data source options.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
Description of the dashboard.
|
String |
getDisplayName()
Display name of the dashboard.
|
List<Object> |
getDrilldownConfig()
Drill-down configuration to define the destination of a drill-down action.
|
Object |
getFeaturesConfig()
Contains configuration for enabling features.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
Boolean |
getIsFavorite()
Determines whether the dashboard is set as favorite.
|
Boolean |
getIsOobDashboard()
Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard.
|
Boolean |
getIsShowDescription()
Determines whether the description of the dashboard is displayed.
|
Boolean |
getIsShowInHome()
Determines whether the dashboard will be displayed in Dashboard Home.
|
String |
getMetadataVersion()
The version of the metadata defined in the API.
|
Object |
getNls()
JSON that contains internationalization options.
|
List<Object> |
getParametersConfig()
Defines parameters for the dashboard.
|
String |
getProviderId()
ID of the service (for example, log-analytics) that owns the dashboard.
|
String |
getProviderName()
The user friendly name of the service (for example, Logging Analytics) that owns the
dashboard.
|
String |
getProviderVersion()
The version of the metadata of the provider.
|
String |
getScreenImage()
Screen image of the dashboard.
|
List<ManagementDashboardTileDetails> |
getTiles()
Array of dashboard tiles.
|
String |
getType()
Type of dashboard.
|
Object |
getUiConfig()
JSON that contains user interface options.
|
int |
hashCode() |
CreateManagementDashboardDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"dashboardId","providerId","providerName","providerVersion","tiles","displayName","description","compartmentId","isOobDashboard","isShowInHome","metadataVersion","isShowDescription","screenImage","nls","uiConfig","dataConfig","type","isFavorite","parametersConfig","featuresConfig","drilldownConfig","freeformTags","definedTags"}) public CreateManagementDashboardDetails(String dashboardId, String providerId, String providerName, String providerVersion, List<ManagementDashboardTileDetails> tiles, String displayName, String description, String compartmentId, Boolean isOobDashboard, Boolean isShowInHome, String metadataVersion, Boolean isShowDescription, String screenImage, Object nls, Object uiConfig, List<Object> dataConfig, String type, Boolean isFavorite, List<Object> parametersConfig, Object featuresConfig, List<Object> drilldownConfig, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static CreateManagementDashboardDetails.Builder builder()
Create a new builder.
public CreateManagementDashboardDetails.Builder toBuilder()
public String getDashboardId()
ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
public String getProviderId()
ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
public String getProviderName()
The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
public String getProviderVersion()
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.
public List<ManagementDashboardTileDetails> getTiles()
Array of dashboard tiles.
public String getDisplayName()
Display name of the dashboard.
public String getDescription()
Description of the dashboard.
public String getCompartmentId()
OCID of the compartment in which the dashboard resides.
public Boolean getIsOobDashboard()
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.
public Boolean getIsShowInHome()
Determines whether the dashboard will be displayed in Dashboard Home.
public String getMetadataVersion()
The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
public Boolean getIsShowDescription()
Determines whether the description of the dashboard is displayed.
public String getScreenImage()
Screen image of the dashboard.
public Object getNls()
JSON that contains internationalization options.
public Object getUiConfig()
JSON that contains user interface options.
public List<Object> getDataConfig()
Array of JSON that contain data source options.
public String getType()
Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
public Boolean getIsFavorite()
Determines whether the dashboard is set as favorite.
public List<Object> getParametersConfig()
Defines parameters for the dashboard.
public Object getFeaturesConfig()
Contains configuration for enabling features.
public List<Object> getDrilldownConfig()
Drill-down configuration to define the destination of a drill-down action.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.