Class DatabaseParameterSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • displayValue

        public DatabaseParameterSummary.Builder displayValue​(String displayValue)
        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.

        Parameters:
        displayValue - the value to set
        Returns:
        this builder
      • isDefault

        public DatabaseParameterSummary.Builder isDefault​(Boolean isDefault)
        Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE).
        Parameters:
        isDefault - the value to set
        Returns:
        this builder
      • isSessionModifiable

        public DatabaseParameterSummary.Builder isSessionModifiable​(Boolean isSessionModifiable)
        Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)
        Parameters:
        isSessionModifiable - the value to set
        Returns:
        this builder
      • isSystemModifiable

        public DatabaseParameterSummary.Builder isSystemModifiable​(DatabaseParameterSummary.IsSystemModifiable isSystemModifiable)
        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.

        Parameters:
        isSystemModifiable - the value to set
        Returns:
        this builder
      • isPdbModifiable

        public DatabaseParameterSummary.Builder isPdbModifiable​(Boolean isPdbModifiable)
        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.

        Parameters:
        isPdbModifiable - the value to set
        Returns:
        this builder
      • isInstanceModifiable

        public DatabaseParameterSummary.Builder isInstanceModifiable​(Boolean isInstanceModifiable)
        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.

        Parameters:
        isInstanceModifiable - the value to set
        Returns:
        this builder
      • isAdjusted

        public DatabaseParameterSummary.Builder isAdjusted​(Boolean isAdjusted)
        Indicates whether Oracle adjusted the input value to a more suitable value.
        Parameters:
        isAdjusted - the value to set
        Returns:
        this builder
      • isDeprecated

        public DatabaseParameterSummary.Builder isDeprecated​(Boolean isDeprecated)
        Indicates whether the parameter has been deprecated (TRUE) or not ( FALSE).
        Parameters:
        isDeprecated - the value to set
        Returns:
        this builder
      • isBasic

        public DatabaseParameterSummary.Builder isBasic​(Boolean isBasic)
        Indicates whether the parameter is a basic parameter (TRUE) or not ( FALSE).
        Parameters:
        isBasic - the value to set
        Returns:
        this builder
      • description

        public DatabaseParameterSummary.Builder description​(String description)
        The description of the parameter.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • ordinal

        public DatabaseParameterSummary.Builder ordinal​(BigDecimal ordinal)
        The position (ordinal number) of the parameter value.

        Useful only for parameters whose values are lists of strings.

        Parameters:
        ordinal - the value to set
        Returns:
        this builder
      • updateComment

        public DatabaseParameterSummary.Builder updateComment​(String updateComment)
        The comments associated with the most recent update.
        Parameters:
        updateComment - the value to set
        Returns:
        this builder
      • containerId

        public DatabaseParameterSummary.Builder containerId​(BigDecimal containerId)
        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.

        Parameters:
        containerId - the value to set
        Returns:
        this builder
      • constraint

        public DatabaseParameterSummary.Builder constraint​(DatabaseParameterSummary.Constraint constraint)
        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.

        Parameters:
        constraint - the value to set
        Returns:
        this builder
      • isSpecified

        public DatabaseParameterSummary.Builder isSpecified​(Boolean isSpecified)
        Indicates whether the parameter was specified in the server parameter file (TRUE) or not (FALSE).

        Applicable only when the parameter source is SPFILE.

        Parameters:
        isSpecified - the value to set
        Returns:
        this builder