Package com.oracle.bmc.managementdashboard.model

Class ManagementDashboardSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.managementdashboard.model.ManagementDashboardSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200901")
public final class ManagementDashboardSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Summary of the properties of a dashboard.
Note: Objects should always be created or deserialized using the ManagementDashboardSummary.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 ManagementDashboardSummary.Builder, which maintain a set of all explicitly set fields called ManagementDashboardSummary.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagementDashboardSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

ManagementDashboardSummary(String dashboardId, String id, String displayName, String description, String compartmentId, String providerId, String providerName, String providerVersion, Boolean isOobDashboard, String createdBy, Date timeCreated, String updatedBy, Date timeUpdated, String metadataVersion, String screenImage, Object nls, String type, Object featuresConfig, LifecycleStates lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ManagementDashboardSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	OCID of the compartment in which the dashboard resides.
String	getCreatedBy()	User who created the dashboard.
String	getDashboardId()	ID of the dashboard.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	Description of the dashboard.
String	getDisplayName()	Display name of the dashboard.
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.
String	getId()	ID of the dashboard.
Boolean	getIsOobDashboard()	Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard.
LifecycleStates	getLifecycleState()	Current lifecycle state of the dashboard.
String	getMetadataVersion()	The version of the metadata defined in the API.
Object	getNls()	JSON that contains internationalization options.
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.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeCreated()	Date and time the dashboard was created.
Date	getTimeUpdated()	Date and time the dashboard was updated.
String	getType()	Type of dashboard.
String	getUpdatedBy()	User who updated the dashboard.
int	hashCode()
ManagementDashboardSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ManagementDashboardSummary

@Deprecated
@ConstructorProperties({"dashboardId","id","displayName","description","compartmentId","providerId","providerName","providerVersion","isOobDashboard","createdBy","timeCreated","updatedBy","timeUpdated","metadataVersion","screenImage","nls","type","featuresConfig","lifecycleState","freeformTags","definedTags","systemTags"})
public ManagementDashboardSummary(String dashboardId,
                                  String id,
                                  String displayName,
                                  String description,
                                  String compartmentId,
                                  String providerId,
                                  String providerName,
                                  String providerVersion,
                                  Boolean isOobDashboard,
                                  String createdBy,
                                  Date timeCreated,
                                  String updatedBy,
                                  Date timeUpdated,
                                  String metadataVersion,
                                  String screenImage,
                                  Object nls,
                                  String type,
                                  Object featuresConfig,
                                  LifecycleStates lifecycleState,
                                  Map<String,String> freeformTags,
                                  Map<String,Map<String,Object>> definedTags,
                                  Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ManagementDashboardSummary.Builder builder()

Create a new builder.

toBuilder

public ManagementDashboardSummary.Builder toBuilder()

getDashboardId

public String getDashboardId()

ID of the dashboard.

Same as id.

Returns:

the value

getId

public String getId()

ID of the dashboard.

Same as dashboardId.

Returns:

the value

getDisplayName

public String getDisplayName()

Display name of the dashboard.

Returns:

the value

getDescription

public String getDescription()

Description of the dashboard.

Returns:

the value

getCompartmentId

public String getCompartmentId()

OCID of the compartment in which the dashboard resides.

Returns:

the value

getProviderId

public String getProviderId()

ID of the service (for example, log-analytics) that owns the dashboard.

Each service has a unique ID.

Returns:

the value

getProviderName

public String getProviderName()

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

Returns:

the value

getProviderVersion

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.

Returns:

the value

getIsOobDashboard

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.

Returns:

the value

getCreatedBy

public String getCreatedBy()

User who created the dashboard.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Date and time the dashboard was created.

Returns:

the value

getUpdatedBy

public String getUpdatedBy()

User who updated the dashboard.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

Date and time the dashboard was updated.

Returns:

the value

getMetadataVersion

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.

Returns:

the value

getScreenImage

public String getScreenImage()

Screen image of the dashboard.

Returns:

the value

getNls

public Object getNls()

JSON that contains internationalization options.

Returns:

the value

getType

public String getType()

Type of dashboard.

NORMAL denotes a single dashboard and SET denotes a dashboard set.

Returns:

the value

getFeaturesConfig

public Object getFeaturesConfig()

Contains configuration for enabling features.

Returns:

the value

getLifecycleState

public LifecycleStates getLifecycleState()

Current lifecycle state of the dashboard.

Returns:

the value

getFreeformTags

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

Returns:

the value

getDefinedTags

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

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel