DatabaseParameterSummary¶

class oci.database_management.models.DatabaseParameterSummary(**kwargs)¶

Bases: object

A summary of the database parameter.

Attributes

`CONSTRAINT_IDENTICAL`	A constant which can be used with the constraint property of a DatabaseParameterSummary.
`CONSTRAINT_NONE`	A constant which can be used with the constraint property of a DatabaseParameterSummary.
`CONSTRAINT_UNIQUE`	A constant which can be used with the constraint property of a DatabaseParameterSummary.
`IS_MODIFIED_FALSE`	A constant which can be used with the is_modified property of a DatabaseParameterSummary.
`IS_MODIFIED_MODIFIED`	A constant which can be used with the is_modified property of a DatabaseParameterSummary.
`IS_SYSTEM_MODIFIABLE_DEFERRED`	A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary.
`IS_SYSTEM_MODIFIABLE_FALSE`	A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary.
`IS_SYSTEM_MODIFIABLE_IMMEDIATE`	A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary.
`TYPE_BIG_INTEGER`	A constant which can be used with the type property of a DatabaseParameterSummary.
`TYPE_BOOLEAN`	A constant which can be used with the type property of a DatabaseParameterSummary.
`TYPE_FILENAME`	A constant which can be used with the type property of a DatabaseParameterSummary.
`TYPE_INTEGER`	A constant which can be used with the type property of a DatabaseParameterSummary.
`TYPE_RESERVED`	A constant which can be used with the type property of a DatabaseParameterSummary.
`TYPE_STRING`	A constant which can be used with the type property of a DatabaseParameterSummary.
`allowed_values`	Gets the allowed_values of this DatabaseParameterSummary.
`category`	Gets the category of this DatabaseParameterSummary.
`constraint`	Gets the constraint of this DatabaseParameterSummary.
`container_id`	Gets the container_id of this DatabaseParameterSummary.
`description`	Gets the description of this DatabaseParameterSummary.
`display_value`	[Required] Gets the display_value of this DatabaseParameterSummary.
`is_adjusted`	Gets the is_adjusted of this DatabaseParameterSummary.
`is_basic`	Gets the is_basic of this DatabaseParameterSummary.
`is_default`	Gets the is_default of this DatabaseParameterSummary.
`is_deprecated`	Gets the is_deprecated of this DatabaseParameterSummary.
`is_instance_modifiable`	Gets the is_instance_modifiable of this DatabaseParameterSummary.
`is_modified`	Gets the is_modified of this DatabaseParameterSummary.
`is_pdb_modifiable`	Gets the is_pdb_modifiable of this DatabaseParameterSummary.
`is_session_modifiable`	Gets the is_session_modifiable of this DatabaseParameterSummary.
`is_specified`	Gets the is_specified of this DatabaseParameterSummary.
`is_system_modifiable`	Gets the is_system_modifiable of this DatabaseParameterSummary.
`name`	[Required] Gets the name of this DatabaseParameterSummary.
`number`	Gets the number of this DatabaseParameterSummary.
`ordinal`	Gets the ordinal of this DatabaseParameterSummary.
`sid`	Gets the sid of this DatabaseParameterSummary.
`type`	[Required] Gets the type of this DatabaseParameterSummary.
`update_comment`	Gets the update_comment of this DatabaseParameterSummary.
`value`	[Required] Gets the value of this DatabaseParameterSummary.

Methods

__init__(**kwargs) Initializes a new DatabaseParameterSummary object with values from keyword arguments.

CONSTRAINT_IDENTICAL = 'IDENTICAL'¶: A constant which can be used with the constraint property of a DatabaseParameterSummary. This constant has a value of “IDENTICAL”

CONSTRAINT_NONE = 'NONE'¶: A constant which can be used with the constraint property of a DatabaseParameterSummary. This constant has a value of “NONE”

CONSTRAINT_UNIQUE = 'UNIQUE'¶: A constant which can be used with the constraint property of a DatabaseParameterSummary. This constant has a value of “UNIQUE”

IS_MODIFIED_FALSE = 'FALSE'¶: A constant which can be used with the is_modified property of a DatabaseParameterSummary. This constant has a value of “FALSE”

IS_MODIFIED_MODIFIED = 'MODIFIED'¶: A constant which can be used with the is_modified property of a DatabaseParameterSummary. This constant has a value of “MODIFIED”

IS_SYSTEM_MODIFIABLE_DEFERRED = 'DEFERRED'¶: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. This constant has a value of “DEFERRED”

IS_SYSTEM_MODIFIABLE_FALSE = 'FALSE'¶: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. This constant has a value of “FALSE”

IS_SYSTEM_MODIFIABLE_IMMEDIATE = 'IMMEDIATE'¶: A constant which can be used with the is_system_modifiable property of a DatabaseParameterSummary. This constant has a value of “IMMEDIATE”

TYPE_BIG_INTEGER = 'BIG_INTEGER'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “BIG_INTEGER”

TYPE_BOOLEAN = 'BOOLEAN'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “BOOLEAN”

TYPE_FILENAME = 'FILENAME'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “FILENAME”

TYPE_INTEGER = 'INTEGER'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “INTEGER”

TYPE_RESERVED = 'RESERVED'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “RESERVED”

TYPE_STRING = 'STRING'¶: A constant which can be used with the type property of a DatabaseParameterSummary. This constant has a value of “STRING”

__init__(**kwargs)¶

Initializes a new DatabaseParameterSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this DatabaseParameterSummary.
type (str) – The value to assign to the type property of this DatabaseParameterSummary. Allowed values for this property are: “BOOLEAN”, “STRING”, “INTEGER”, “FILENAME”, “BIG_INTEGER”, “RESERVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
value (str) – The value to assign to the value property of this DatabaseParameterSummary.
display_value (str) – The value to assign to the display_value property of this DatabaseParameterSummary.
number (float) – The value to assign to the number property of this DatabaseParameterSummary.
is_default (bool) – The value to assign to the is_default property of this DatabaseParameterSummary.
is_session_modifiable (bool) – The value to assign to the is_session_modifiable property of this DatabaseParameterSummary.
is_system_modifiable (str) – The value to assign to the is_system_modifiable property of this DatabaseParameterSummary. Allowed values for this property are: “IMMEDIATE”, “DEFERRED”, “FALSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_pdb_modifiable (bool) – The value to assign to the is_pdb_modifiable property of this DatabaseParameterSummary.
is_instance_modifiable (bool) – The value to assign to the is_instance_modifiable property of this DatabaseParameterSummary.
is_modified (str) – The value to assign to the is_modified property of this DatabaseParameterSummary. Allowed values for this property are: “MODIFIED”, “FALSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_adjusted (bool) – The value to assign to the is_adjusted property of this DatabaseParameterSummary.
is_deprecated (bool) – The value to assign to the is_deprecated property of this DatabaseParameterSummary.
is_basic (bool) – The value to assign to the is_basic property of this DatabaseParameterSummary.
description (str) – The value to assign to the description property of this DatabaseParameterSummary.
ordinal (float) – The value to assign to the ordinal property of this DatabaseParameterSummary.
update_comment (str) – The value to assign to the update_comment property of this DatabaseParameterSummary.
container_id (float) – The value to assign to the container_id property of this DatabaseParameterSummary.
category (str) – The value to assign to the category property of this DatabaseParameterSummary.
constraint (str) – The value to assign to the constraint property of this DatabaseParameterSummary. Allowed values for this property are: “UNIQUE”, “IDENTICAL”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sid (str) – The value to assign to the sid property of this DatabaseParameterSummary.
is_specified (bool) – The value to assign to the is_specified property of this DatabaseParameterSummary.
allowed_values (list[oci.database_management.models.AllowedParameterValue]) – The value to assign to the allowed_values property of this DatabaseParameterSummary.

allowed_values¶

Gets the allowed_values of this DatabaseParameterSummary. A list of allowed values for this parameter.

Returns:	The allowed_values of this DatabaseParameterSummary.
Return type:	list[oci.database_management.models.AllowedParameterValue]

category¶

Gets the category of this DatabaseParameterSummary. The parameter category.

Returns:	The category of this DatabaseParameterSummary.
Return type:	str

constraint¶

Gets the constraint of this DatabaseParameterSummary. 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.

Allowed values for this property are: “UNIQUE”, “IDENTICAL”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The constraint of this DatabaseParameterSummary.
Return type:	str

container_id¶

Gets the container_id of this DatabaseParameterSummary. 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 container_id of this DatabaseParameterSummary.
Return type:	float

description¶

Gets the description of this DatabaseParameterSummary. The description of the parameter.

Returns:	The description of this DatabaseParameterSummary.
Return type:	str

display_value¶

[Required] Gets the display_value of this DatabaseParameterSummary. 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 display_value of this DatabaseParameterSummary.
Return type:	str

is_adjusted¶

Gets the is_adjusted of this DatabaseParameterSummary. Indicates whether Oracle adjusted the input value to a more suitable value.

Returns:	The is_adjusted of this DatabaseParameterSummary.
Return type:	bool

is_basic¶

Gets the is_basic of this DatabaseParameterSummary. Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE).

Returns:	The is_basic of this DatabaseParameterSummary.
Return type:	bool

is_default¶

Gets the is_default of this DatabaseParameterSummary. Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE).

Returns:	The is_default of this DatabaseParameterSummary.
Return type:	bool

is_deprecated¶

Gets the is_deprecated of this DatabaseParameterSummary. Indicates whether the parameter has been deprecated (TRUE) or not (FALSE).

Returns:	The is_deprecated of this DatabaseParameterSummary.
Return type:	bool

is_instance_modifiable¶

Gets the is_instance_modifiable of this DatabaseParameterSummary. 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 is_instance_modifiable of this DatabaseParameterSummary.
Return type:	bool

is_modified¶

Gets the is_modified of this DatabaseParameterSummary. Indicates how the parameter was modified. If an ALTER SYSTEM was performed, the value will be MODIFIED.

Allowed values for this property are: “MODIFIED”, “FALSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The is_modified of this DatabaseParameterSummary.
Return type:	str

is_pdb_modifiable¶

Gets the is_pdb_modifiable of this DatabaseParameterSummary. 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 is_pdb_modifiable of this DatabaseParameterSummary.
Return type:	bool

is_session_modifiable¶

Gets the is_session_modifiable of this DatabaseParameterSummary. Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE)

Returns:	The is_session_modifiable of this DatabaseParameterSummary.
Return type:	bool

is_specified¶

Gets the is_specified of this DatabaseParameterSummary. 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 is_specified of this DatabaseParameterSummary.
Return type:	bool

is_system_modifiable¶

Gets the is_system_modifiable of this DatabaseParameterSummary. 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.

Allowed values for this property are: “IMMEDIATE”, “DEFERRED”, “FALSE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The is_system_modifiable of this DatabaseParameterSummary.
Return type:	str

name¶

[Required] Gets the name of this DatabaseParameterSummary. The parameter name.

Returns:	The name of this DatabaseParameterSummary.
Return type:	str

number¶

Gets the number of this DatabaseParameterSummary. The parameter number.

Returns:	The number of this DatabaseParameterSummary.
Return type:	float

ordinal¶

Gets the ordinal of this DatabaseParameterSummary. The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings.

Returns:	The ordinal of this DatabaseParameterSummary.
Return type:	float

sid¶

Gets the sid of this DatabaseParameterSummary. The database instance SID for which the parameter is defined.

Returns:	The sid of this DatabaseParameterSummary.
Return type:	str

type¶

[Required] Gets the type of this DatabaseParameterSummary. The parameter type.

Allowed values for this property are: “BOOLEAN”, “STRING”, “INTEGER”, “FILENAME”, “BIG_INTEGER”, “RESERVED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this DatabaseParameterSummary.
Return type:	str

update_comment¶

Gets the update_comment of this DatabaseParameterSummary. The comments associated with the most recent update.

Returns:	The update_comment of this DatabaseParameterSummary.
Return type:	str

value¶

[Required] Gets the value of this DatabaseParameterSummary. The parameter value.

Returns:	The value of this DatabaseParameterSummary.
Return type:	str