Class DatabaseParameterSummary

A summary of the database parameter.

Inheritance

object

DatabaseParameterSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemanagementService.Models

Assembly: OCI.DotNetSDK.Databasemanagement.dll

Syntax

public class DatabaseParameterSummary

Properties

AllowedValues

Declaration

[JsonProperty(PropertyName = "allowedValues")]
public List<AllowedParameterValue> AllowedValues { get; set; }

Property Value

Type	Description
List<AllowedParameterValue>	A list of allowed values for this parameter.

Category

Declaration

[JsonProperty(PropertyName = "category")]
public string Category { get; set; }

Property Value

Type	Description
string	The parameter category.

Constraint

Declaration

[JsonProperty(PropertyName = "constraint")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseParameterSummary.ConstraintEnum? Constraint { get; set; }

Property Value

Type

Description

DatabaseParameterSummary.ConstraintEnum?

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.

ContainerId

Declaration

[JsonProperty(PropertyName = "containerId")]
public decimal? ContainerId { get; set; }

Property Value

Type	Description
decimal?	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.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description of the parameter.

DisplayValue

Declaration

[Required(ErrorMessage = "DisplayValue is required.")]
[JsonProperty(PropertyName = "displayValue")]
public string DisplayValue { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

IsAdjusted

Declaration

[JsonProperty(PropertyName = "isAdjusted")]
public bool? IsAdjusted { get; set; }

Property Value

Type	Description
bool?	Indicates whether Oracle adjusted the input value to a more suitable value.

IsBasic

Declaration

[JsonProperty(PropertyName = "isBasic")]
public bool? IsBasic { get; set; }

Property Value

Type	Description
bool?	Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE).

IsDefault

Declaration

[JsonProperty(PropertyName = "isDefault")]
public bool? IsDefault { get; set; }

Property Value

Type	Description
bool?	Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE).

IsDeprecated

Declaration

[JsonProperty(PropertyName = "isDeprecated")]
public bool? IsDeprecated { get; set; }

Property Value

Type	Description
bool?	Indicates whether the parameter has been deprecated (TRUE) or not (FALSE).

IsInstanceModifiable

Declaration

[JsonProperty(PropertyName = "isInstanceModifiable")]
public bool? IsInstanceModifiable { get; set; }

Property Value

Type	Description
bool?	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.

IsModified

Declaration

[JsonProperty(PropertyName = "isModified")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseParameterSummary.IsModifiedEnum? IsModified { get; set; }

Property Value

Type	Description
DatabaseParameterSummary.IsModifiedEnum?	Indicates how the parameter was modified. If an ALTER SYSTEM was performed, the value will be MODIFIED.

IsPdbModifiable

Declaration

[JsonProperty(PropertyName = "isPdbModifiable")]
public bool? IsPdbModifiable { get; set; }

Property Value

Type	Description
bool?	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.

IsSessionModifiable

Declaration

[JsonProperty(PropertyName = "isSessionModifiable")]
public bool? IsSessionModifiable { get; set; }

Property Value

Type	Description
bool?	Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)

IsSpecified

Declaration

[JsonProperty(PropertyName = "isSpecified")]
public bool? IsSpecified { get; set; }

Property Value

Type	Description
bool?	Indicates whether the parameter was specified in the server parameter file (TRUE) or not (FALSE). Applicable only when the parameter source is SPFILE.

IsSystemModifiable

Declaration

[JsonProperty(PropertyName = "isSystemModifiable")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseParameterSummary.IsSystemModifiableEnum? IsSystemModifiable { get; set; }

Property Value

Type

Description

DatabaseParameterSummary.IsSystemModifiableEnum?

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.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	The parameter name.

Remarks

Required

Number

Declaration

[JsonProperty(PropertyName = "number")]
public decimal? Number { get; set; }

Property Value

Type	Description
decimal?	The parameter number.

Ordinal

Declaration

[JsonProperty(PropertyName = "ordinal")]
public decimal? Ordinal { get; set; }

Property Value

Type	Description
decimal?	The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings.

Sid

Declaration

[JsonProperty(PropertyName = "sid")]
public string Sid { get; set; }

Property Value

Type	Description
string	The database instance SID for which the parameter is defined.

Type

Declaration

[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseParameterSummary.TypeEnum? Type { get; set; }

Property Value

Type	Description
DatabaseParameterSummary.TypeEnum?	The parameter type.

Remarks

Required

UpdateComment

Declaration

[JsonProperty(PropertyName = "updateComment")]
public string UpdateComment { get; set; }

Property Value

Type	Description
string	The comments associated with the most recent update.

Value

Declaration

[Required(ErrorMessage = "Value is required.")]
[JsonProperty(PropertyName = "value")]
public string Value { get; set; }

Property Value

Type	Description
string	The parameter value.

Remarks

Required