Package com.oracle.bmc.dashboardservice.model

Class Dashboard

  • Direct Known Subclasses:
    V1Dashboard
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210731")
public class Dashboard
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The base schema for a dashboard.

    Derived schemas have configurations and widgets specific to the schemaVersion.
    Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the dashboard resource.
        Returns:
        the value

      • getDashboardGroupId

        public String getDashboardGroupId()
        The OCID of the dashboard group that the dashboard belongs to.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the dashboard.

        Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/’"&\

        Returns:
        the value

      • getDescription

        public String getDescription()
        A short description of the dashboard.

        It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/’"&\

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the dashboard.

        A dashboard is always in the same compartment as its dashboard group.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the dashboard was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the dashboard was updated, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public Dashboard.LifecycleState getLifecycleState()
        The current 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