@Generated(value="OracleSDKGenerator", comments="API Version: 20201101") public final class DatabaseParameterSummary extends Object
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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
DatabaseParameterSummary.Builder |
static class |
DatabaseParameterSummary.Constraint
Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases.
|
static class |
DatabaseParameterSummary.IsModified
Indicates how the parameter was modified.
|
static class |
DatabaseParameterSummary.IsSystemModifiable
Indicates whether the parameter can be changed with
ALTER SYSTEM and when the change takes effect: |
static class |
DatabaseParameterSummary.Type
The parameter type.
|
| Constructor and Description |
|---|
DatabaseParameterSummary(String name,
DatabaseParameterSummary.Type type,
String value,
String displayValue,
BigDecimal number,
Boolean isDefault,
Boolean isSessionModifiable,
DatabaseParameterSummary.IsSystemModifiable isSystemModifiable,
Boolean isPdbModifiable,
Boolean isInstanceModifiable,
DatabaseParameterSummary.IsModified isModified,
Boolean isAdjusted,
Boolean isDeprecated,
Boolean isBasic,
String description,
BigDecimal ordinal,
String updateComment,
BigDecimal containerId,
String category,
DatabaseParameterSummary.Constraint constraint,
String sid,
Boolean isSpecified,
List<AllowedParameterValue> allowedValues)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static DatabaseParameterSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
List<AllowedParameterValue> |
getAllowedValues()
A list of allowed values for this parameter.
|
String |
getCategory()
The parameter category.
|
DatabaseParameterSummary.Constraint |
getConstraint()
Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases.
|
BigDecimal |
getContainerId()
The ID of the database container to which the data pertains.
|
String |
getDescription()
The description of the parameter.
|
String |
getDisplayValue()
The parameter value in a user-friendly format.
|
Boolean |
getIsAdjusted()
Indicates whether Oracle adjusted the input value to a more suitable value.
|
Boolean |
getIsBasic()
Indicates whether the parameter is a basic parameter (
TRUE) or not (FALSE). |
Boolean |
getIsDefault()
Indicates whether the parameter is set to the default value (
TRUE) or the parameter value was specified in the parameter file (FALSE). |
Boolean |
getIsDeprecated()
Indicates whether the parameter has been deprecated (
TRUE) or not (FALSE). |
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). |
DatabaseParameterSummary.IsModified |
getIsModified()
Indicates how the parameter was modified.
|
Boolean |
getIsPdbModifiable()
Indicates whether the parameter can be modified on a per-PDB basis (
TRUE) or not (FALSE). |
Boolean |
getIsSessionModifiable()
Indicates whether the parameter can be changed with
ALTER SESSION (TRUE) or not (FALSE) |
Boolean |
getIsSpecified()
Indicates whether the parameter was specified in the server parameter file (
TRUE) or not (FALSE). |
DatabaseParameterSummary.IsSystemModifiable |
getIsSystemModifiable()
Indicates whether the parameter can be changed with
ALTER SYSTEM and when the change takes effect: |
String |
getName()
The parameter name.
|
BigDecimal |
getNumber()
The parameter number.
|
BigDecimal |
getOrdinal()
The position (ordinal number) of the parameter value.
|
String |
getSid()
The database instance SID for which the parameter is defined.
|
DatabaseParameterSummary.Type |
getType()
The parameter type.
|
String |
getUpdateComment()
The comments associated with the most recent update.
|
String |
getValue()
The parameter value.
|
int |
hashCode() |
DatabaseParameterSummary.Builder |
toBuilder() |
String |
toString() |
@Deprecated @ConstructorProperties(value={"name","type","value","displayValue","number","isDefault","isSessionModifiable","isSystemModifiable","isPdbModifiable","isInstanceModifiable","isModified","isAdjusted","isDeprecated","isBasic","description","ordinal","updateComment","containerId","category","constraint","sid","isSpecified","allowedValues"}) public DatabaseParameterSummary(String name, DatabaseParameterSummary.Type type, String value, String displayValue, BigDecimal number, Boolean isDefault, Boolean isSessionModifiable, DatabaseParameterSummary.IsSystemModifiable isSystemModifiable, Boolean isPdbModifiable, Boolean isInstanceModifiable, DatabaseParameterSummary.IsModified isModified, Boolean isAdjusted, Boolean isDeprecated, Boolean isBasic, String description, BigDecimal ordinal, String updateComment, BigDecimal containerId, String category, DatabaseParameterSummary.Constraint constraint, String sid, Boolean isSpecified, List<AllowedParameterValue> allowedValues)
public static DatabaseParameterSummary.Builder builder()
Create a new builder.
public DatabaseParameterSummary.Builder toBuilder()
public String getName()
The parameter name.
public DatabaseParameterSummary.Type getType()
The parameter type.
public String getValue()
The parameter value.
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.
public BigDecimal getNumber()
The parameter number.
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).
public Boolean getIsSessionModifiable()
Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)
public DatabaseParameterSummary.IsSystemModifiable getIsSystemModifiable()
Indicates whether the parameter can be changed with ALTER SYSTEM and when the change takes effect:
ALTER SYSTEM regardless of the type of parameter file used to start the instance. The change takes effect immediately.ALTER SYSTEM regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions.ALTER SYSTEM unless a server parameter file was used to start the instance. The change takes effect in subsequent instances.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.
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.
public DatabaseParameterSummary.IsModified getIsModified()
Indicates how the parameter was modified. If an ALTER SYSTEM was performed, the value will be MODIFIED.
public Boolean getIsAdjusted()
Indicates whether Oracle adjusted the input value to a more suitable value.
public Boolean getIsDeprecated()
Indicates whether the parameter has been deprecated (TRUE) or not (FALSE).
public Boolean getIsBasic()
Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE).
public String getDescription()
The description of the parameter.
public BigDecimal getOrdinal()
The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings.
public String getUpdateComment()
The comments associated with the most recent update.
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.public String getCategory()
The parameter category.
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.
public String getSid()
The database instance SID for which the parameter is defined.
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.
public List<AllowedParameterValue> getAllowedValues()
A list of allowed values for this parameter.
Copyright © 2016–2022. All rights reserved.