Package com.oracle.bmc.managementdashboard.model

Class CreateManagementDashboardDetails

  • @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).

    • Method Detail

      • getDashboardId

        public String getDashboardId()
        ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
        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

      • 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

      • 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

      • getIsShowInHome

        public Boolean getIsShowInHome()
        Determines whether the dashboard will be displayed in Dashboard Home.
        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

      • getIsShowDescription

        public Boolean getIsShowDescription()
        Determines whether the description of the dashboard is displayed.
        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

      • getUiConfig

        public Object getUiConfig()
        JSON that contains user interface options.
        Returns:
        the value

      • getDataConfig

        public List<Object> getDataConfig()
        Array of JSON that contain data source 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

      • getIsFavorite

        public Boolean getIsFavorite()
        Determines whether the dashboard is set as favorite.
        Returns:
        the value

      • getParametersConfig

        public List<Object> getParametersConfig()
        Defines parameters for the dashboard.
        Returns:
        the value

      • getFeaturesConfig

        public Object getFeaturesConfig()
        Contains configuration for enabling features.
        Returns:
        the value

      • getDrilldownConfig

        public List<Object> getDrilldownConfig()
        Drill-down configuration to define the destination of a drill-down action.
        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

      • 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