StandByDatabaseDataguardMetrics¶

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

Bases: object

The standby database details.

Attributes

`DB_ROLE_FAR_SYNC`	A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics.
`DB_ROLE_LOGICAL_STANDBY`	A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics.
`DB_ROLE_PHYSICAL_STANDBY`	A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics.
`DB_ROLE_PRIMARY`	A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics.
`DB_ROLE_SNAPSHOT_STANDBY`	A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics.
`compartment_id`	[Required] Gets the compartment_id of this StandByDatabaseDataguardMetrics.
`database_id`	Gets the database_id of this StandByDatabaseDataguardMetrics.
`database_name`	[Required] Gets the database_name of this StandByDatabaseDataguardMetrics.
`db_id`	[Required] Gets the db_id of this StandByDatabaseDataguardMetrics.
`db_role`	[Required] Gets the db_role of this StandByDatabaseDataguardMetrics.
`db_unique_name`	Gets the db_unique_name of this StandByDatabaseDataguardMetrics.
`metrics`	[Required] Gets the metrics of this StandByDatabaseDataguardMetrics.

Methods

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

DB_ROLE_FAR_SYNC = 'FAR_SYNC'¶: A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics. This constant has a value of “FAR_SYNC”

DB_ROLE_LOGICAL_STANDBY = 'LOGICAL_STANDBY'¶: A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics. This constant has a value of “LOGICAL_STANDBY”

DB_ROLE_PHYSICAL_STANDBY = 'PHYSICAL_STANDBY'¶: A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics. This constant has a value of “PHYSICAL_STANDBY”

DB_ROLE_PRIMARY = 'PRIMARY'¶: A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics. This constant has a value of “PRIMARY”

DB_ROLE_SNAPSHOT_STANDBY = 'SNAPSHOT_STANDBY'¶: A constant which can be used with the db_role property of a StandByDatabaseDataguardMetrics. This constant has a value of “SNAPSHOT_STANDBY”

__init__(**kwargs)¶

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

Parameters:

db_id (str) – The value to assign to the db_id property of this StandByDatabaseDataguardMetrics.
compartment_id (str) – The value to assign to the compartment_id property of this StandByDatabaseDataguardMetrics.
database_id (str) – The value to assign to the database_id property of this StandByDatabaseDataguardMetrics.
database_name (str) – The value to assign to the database_name property of this StandByDatabaseDataguardMetrics.
db_unique_name (str) – The value to assign to the db_unique_name property of this StandByDatabaseDataguardMetrics.
db_role (str) – The value to assign to the db_role property of this StandByDatabaseDataguardMetrics. Allowed values for this property are: “SNAPSHOT_STANDBY”, “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
metrics (list[oci.database_management.models.HaMetricDefinition]) – The value to assign to the metrics property of this StandByDatabaseDataguardMetrics.

compartment_id¶

[Required] Gets the compartment_id of this StandByDatabaseDataguardMetrics. The OCID of the compartment where the Managed Database resides.

Returns:	The compartment_id of this StandByDatabaseDataguardMetrics.
Return type:	str

database_id¶

Gets the database_id of this StandByDatabaseDataguardMetrics. The database ID of the Managed Database. Every database had its own ID and that value is captured here.

Returns:	The database_id of this StandByDatabaseDataguardMetrics.
Return type:	str

database_name¶

[Required] Gets the database_name of this StandByDatabaseDataguardMetrics. The display name of the Managed Database.

Returns:	The database_name of this StandByDatabaseDataguardMetrics.
Return type:	str

db_id¶

[Required] Gets the db_id of this StandByDatabaseDataguardMetrics. The OCID of the Managed Database.

Returns:	The db_id of this StandByDatabaseDataguardMetrics.
Return type:	str

db_role¶

[Required] Gets the db_role of this StandByDatabaseDataguardMetrics. The database role of the Managed Database.

Allowed values for this property are: “SNAPSHOT_STANDBY”, “LOGICAL_STANDBY”, “PHYSICAL_STANDBY”, “PRIMARY”, “FAR_SYNC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The db_role of this StandByDatabaseDataguardMetrics.
Return type:	str

db_unique_name¶

Gets the db_unique_name of this StandByDatabaseDataguardMetrics. The database unique name of the Managed Database.

Returns:	The db_unique_name of this StandByDatabaseDataguardMetrics.
Return type:	str

metrics¶

[Required] Gets the metrics of this StandByDatabaseDataguardMetrics. A list of standby databases with latest values for metrics such as ApplyLag, TransportLag, and RedoApplyRate.

Returns:	The metrics of this StandByDatabaseDataguardMetrics.
Return type:	list[oci.database_management.models.HaMetricDefinition]