Package com.oracle.bmc.databasemanagement.model

Class DatabaseParameterSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20201101")
public final class DatabaseParameterSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A summary of the database parameter.
    Note: Objects should always be created or deserialized using the DatabaseParameterSummary.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 DatabaseParameterSummary.Builder, which maintain a set of all explicitly set fields called DatabaseParameterSummary.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

      • getName

        public String getName()
        The parameter name.
        Returns:
        the value

      • getValue

        public String getValue()
        The parameter value.
        Returns:
        the value

      • getDisplayValue

        public String getDisplayValue()
        The parameter value in a user-friendly format.

        For example, if the value property shows the value 262144 for a big integer parameter, then the displayValue property will show the value 256K.

        Returns:
        the value

      • getNumber

        public BigDecimal getNumber()
        The parameter number.
        Returns:
        the value

      • getIsDefault

        public Boolean getIsDefault()
        Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE).
        Returns:
        the value

      • getIsSessionModifiable

        public Boolean getIsSessionModifiable()
        Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)
        Returns:
        the value

      • getIsSystemModifiable

        public DatabaseParameterSummary.IsSystemModifiable getIsSystemModifiable()
        Indicates whether the parameter can be changed with ALTER SYSTEM and when the change takes effect: - IMMEDIATE: Parameter can be changed with ALTER SYSTEM regardless of the type of parameter file used to start the instance.

        The change takes effect immediately. - DEFERRED: Parameter can be changed with ALTER SYSTEM regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions. - FALSE: Parameter cannot be changed with ALTER SYSTEM unless a server parameter file was used to start the instance. The change takes effect in subsequent instances.

        Returns:
        the value

      • getIsPdbModifiable

        public Boolean getIsPdbModifiable()
        Indicates whether the parameter can be modified on a per-PDB basis (TRUE) or not (FALSE).

        In a non-CDB, the value of this property is null.

        Returns:
        the value

      • getIsInstanceModifiable

        public Boolean getIsInstanceModifiable()
        For parameters that can be changed with ALTER SYSTEM, indicates whether the value of the parameter can be different for every instance (TRUE) or whether the parameter must have the same value for all Real Application Clusters instances (FALSE).

        For other parameters, this is always FALSE.

        Returns:
        the value

      • getIsModified

        public DatabaseParameterSummary.IsModified getIsModified()
        Indicates how the parameter was modified.

        If an ALTER SYSTEM was performed, the value will be MODIFIED.

        Returns:
        the value

      • getIsAdjusted

        public Boolean getIsAdjusted()
        Indicates whether Oracle adjusted the input value to a more suitable value.
        Returns:
        the value

      • getIsDeprecated

        public Boolean getIsDeprecated()
        Indicates whether the parameter has been deprecated (TRUE) or not (FALSE).
        Returns:
        the value

      • getIsBasic

        public Boolean getIsBasic()
        Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE).
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the parameter.
        Returns:
        the value

      • getOrdinal

        public BigDecimal getOrdinal()
        The position (ordinal number) of the parameter value.

        Useful only for parameters whose values are lists of strings.

        Returns:
        the value

      • getUpdateComment

        public String getUpdateComment()
        The comments associated with the most recent update.
        Returns:
        the value

      • getContainerId

        public BigDecimal getContainerId()
        The ID of the database container to which the data pertains.

        Possible values include: - 0: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs. - 1: This value is used for data that pertain to only the root container. - n: Where n is the applicable container ID for the data.

        Returns:
        the value

      • getCategory

        public String getCategory()
        The parameter category.
        Returns:
        the value

      • getConstraint

        public DatabaseParameterSummary.Constraint getConstraint()
        Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases.

        A UNIQUE parameter is one which is unique to each Oracle Real Application Clusters (Oracle RAC) instance. For example, the parameter INSTANCE_NUMBER must have different values in each instance. An IDENTICAL parameter must have the same value for every instance. For example, the parameter DB_BLOCK_SIZE must have the same value in all instances.

        Returns:
        the value

      • getSid

        public String getSid()
        The database instance SID for which the parameter is defined.
        Returns:
        the value

      • getIsSpecified

        public Boolean getIsSpecified()
        Indicates whether the parameter was specified in the server parameter file (TRUE) or not (FALSE).

        Applicable only when the parameter source is SPFILE.

        Returns:
        the value

      • getAllowedValues

        public List<AllowedParameterValue> getAllowedValues()
        A list of allowed values for this parameter.
        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